Hur man använder kommentarsfunktionen på bästa sätt i MySQL

Kommentarer används för att lägga till information till koden. Det ignoreras mestadels av kompilatorn, men mänskliga specialister kan läsa dessa kommentarer när de tittar på din kod. Kommentarer är viktiga för utvecklare eftersom de har begränsad tid, och genom att kommentera kan de få värdefull information på en gång eller notera några avgörande detaljer angående koden. Genom att komma åt denna data kan de fatta rätt beslut och arbeta snabbare.

Hur kan det vara användbart för mig att kommentera?

Kommentarer är användbara för dig personligen och för alla som kan behöva läsa eller redigera den här koden senare. Men hur exakt?

• Kommentarer kan vara platshållare vid kodning. I det ögonblicket kanske du antar något, och du skulle veta om ditt antagande är sant i framtiden.

• Kommentarer kan dokumentera dina tankar eller vara anteckningar för dig själv så att du inte glömmer vad du gör när du kommer tillbaka till dem senare.

• Du kan inkludera kommentarer om vad du har gjort i din kod för att andra programmerare ska förstå det bättre och snabbare (kodarnas tid är väldigt, väldigt dyr).

• Du kan använda kommentarer för att tillfälligt inaktivera eller aktivera buggy delar.

• Att kommentera varje rad i ett skript gör det enklare att spåra var buggar kan finnas i programmet.

• Kommentarer kan förklara vad vissa rader kod gör, eller varför du valde något särskilt tillvägagångssätt för att undvika missförstånd (till exempel när vissa delar av koden är avsedda för ett avsnitt eller det särskilda syftet som du bör förstå tydligt) ,

• Du kan skriva ett helt stycke och förklara alla detaljer om kodavsnittet om det behövs för nybörjare eller personer från andra projekt. Kommentarer behövs ofta när du skriver komplexa SQL-frågor med många satser som INNER JOINs, GROUP BYs, etc.

• Kommenterande låter dig göra anteckningar om vad du gör. Detta hjälper andra att förstå hur och varför du gjorde något så att de kan underhålla eller ändra det efter behov.

Är SQL ett bra språk för kommentarer?

ja! Kommentarer används oftast i samband med språk som SQL och PHP där vi kan infoga dem i en textfil eller ett skript med hjälp av kommentarsfunktionen * / (t.ex. /* This is my comment */). De är vanligtvis lika lätta att använda någon annanstans också.

Hur kommenterar man i SQL?

Kommentarsfunktionen låter dig skriva vilken text som helst för att lägga till en kommentar i SQL. Det påverkar inte den slutliga utgången så länge den kommer före eller efter ett bestämt förprogrammerat tecken.

För att lägga till kommentarer i SQL kan du använda följande symboler:/* */ eller # eller — (dubbelstreck).

/* */ fungerar för alla situationer där du vill börja och avsluta din kommentar vid den tidpunkten utan att använda något annat (som enstaka citattecken).

# används för en rad kod i taget

— gäller även för en kodrad åt gången. Glöm inte att sätta ett mellanslag efter detta dubbelstreck.

I din kod skulle det se ut så här:

-- this is a comment

# this is also a comment

/*
   multiline
   comment
*/

Här är skillnaden mellan kommentarerna med en rad och flera rader:

mysql> SELECT 1+1;     # This comment continues to the end of line
mysql> SELECT 1+1;     -- This comment continues to the end of line
mysql> SELECT 1 /* this is an in-line comment */ + 1;
mysql> SELECT 1+
/*
this is a
multiple-line comment
*/
1;

Här är ett annat exempel på en kommentar med flera rader:

SELECT contact_id, last_name, first_name
/*
 * Author: TechOnTheNet.com
 * Purpose: To show a comment that spans multiple lines in your SQL
 * statement in MySQL.
 */
FROM contacts;

Kommentera med #-symbolen

Den grundläggande hash-kommentaren stil kan infogas i text så här:

Select * from users ; # this will list users

Kommentera med dubbelstreck (–)

Detta är mer eller mindre detsamma (glöm inte utrymmet). Standard SQL kräver faktiskt inte att du använder utrymmet där, men MySQL använder det för att undvika problem med kommandon som SELECT 10–1.

Select * from users ; -- this will list users

Kommentera med / * och * / symbolerna

Denna flerradskommentar, till skillnad från de två föregående exemplen, behöver inte stanna vid slutet av raden.

Select * from users ; /* this will list users */

Körbara kommentarer

Som regel ignoreras kommentarer av den som befinner sig i andra änden (eftersom de bara är för programmerare), men vissa kommentartyper – körbara kommentarer – möjliggör att koden körs på vissa system.

I vårt fall tillåter körbara kommentarer dig att använda SQL-koder som endast kommer att köras i MYSQL, inte i andra databaser.

Körbara kommentarer bör finnas i stjärnstreckade snedstreck , som med den vanliga koden:

/*! MySQL-specifik kod */

Dessa körbara kommentarer kräver dock en specifik syntax som nedan:

/*!##### MySQL-specifik kod */

Du behöver !##### del för att signalera körbara kommentarer. Den representerar den lägsta versionen av MYSQL som kan exekvera kommentarer.

Istället för den första hashen, ersätt huvudversionen av MYSQL. Istället för den andra ersätts de 2 sista med den yngre versionen och versionerna av patchen.

Endast MySQL 5.1.10 eller senare version kan köra följande kommentarer:

CREATE TABLE t1 (
k INT AUTO_INCREMENT,
KEY (k)
) /*!50110 KEY_BLOCK_SIZE=1024; */

Slutsats

Kommentarer gör programmen lättare att läsa genom att lägga till mer information. Du kan tänka på dem som något liknande hash – de minskar tiden som krävs för att förstå koden eller identifierar vissa delar av den drastiskt genom att tillhandahålla utdrag som fångar textens essens. Om du någonsin har arbetat med nollkunskapsbevis eller försökt logga in på Facebook via Google, vet du vad vi menar.

Det är därför det är viktigt att kommentera din kod och veta hur man gör det korrekt. Att hålla din kod korrekt med informativa anteckningar gör livet enklare för alla inblandade specialister.