Kommentarer bruges til at tilføje information til koden. Det ignoreres for det meste af compileren, men menneskelige specialister kan læse disse kommentarer, når de ser din kode. Kommentarer er essentielle for udviklere, fordi de har begrænset tid, og kommentarer giver dem mulighed for at få værdifuld information på én gang eller notere nogle afgørende detaljer i forhold til koden. Adgang til disse data lader dem træffe de rigtige beslutninger og arbejde hurtigere.
Hvordan kan kommentarer være nyttige for mig?
Kommentarer er nyttige for dig personligt og for alle, der måske har brug for at læse eller redigere denne kode senere. Men hvordan præcist?
- Kommentarer kan være pladsholdere ved kodning. I det øjeblik antager du måske noget, og du vil vide, om din antagelse er sand i fremtiden.
- Kommentarer kan dokumentere dine tanker eller være notater til dig selv, så du ikke glemmer dine handlinger, når du vender tilbage til dem senere.
- Du kan inkludere kommentarer til, hvad du har gjort i din kode, så andre programmører kan forstå det bedre og hurtigere (kodernes tid er meget, meget dyrt).
- Du kan bruge kommentarer til midlertidigt at deaktivere eller aktivere buggy-dele.
- Hvis du kommenterer hver linje i et script, bliver det nemmere at spore, hvor der kan være fejl i programmet.
- Kommentarer kan forklare, hvad visse linjer kode gør, eller hvorfor du har valgt en bestemt tilgang for at undgå eventuelle misforståelser (f.eks. når nogle dele af koden er beregnet til et afsnit eller det særlige formål, som du bør forstå klart) ,
- Du kan skrive et helt afsnit, der forklarer alle detaljerne om kodeafsnittet, hvis det er nødvendigt for nybegyndere eller folk fra andre projekter. Det er ofte nødvendigt at kommentere, når du skriver komplekse SQL-forespørgsler med mange klausuler såsom INNER JOINs, GROUP BYs osv.
- Kommentering giver dig mulighed for at lave noter om, hvad du laver. Dette hjælper andre med at forstå, hvordan og hvorfor du gjorde noget, så de kan vedligeholde eller ændre det efter behov.
Er SQL et godt sprog til kommentarer?
Ja! Kommentarer bruges oftest i forbindelse med sprog som SQL og PHP, hvor vi kan indsætte dem i en tekstfil eller script ved hjælp af kommentarfunktionen * / (f.eks. /* This is my comment */). De er typisk lige så nemme at bruge andre steder også.
Hvordan kommenterer man i SQL?
Kommentarfunktionen giver dig mulighed for at skrive enhver tekst for at tilføje en kommentar i SQL. Det påvirker ikke det endelige output, så længe det kommer før eller efter et bestemt forprogrammeret tegn.
For at tilføje kommentarer i SQL kan du bruge følgende symboler:/* */ eller # eller — (dobbeltstreg).
/* */ vil fungere i enhver situation, hvor du vil starte og afslutte din kommentar på det tidspunkt uden at bruge noget andet (såsom enkelte anførselstegn).
# bruges til én kodelinje ad gangen
— gælder også for én kodelinje ad gangen. Glem ikke at sætte et mellemrum efter denne dobbelte tankestreg.
I din kode ville det se ud som følger:
-- this is a comment# this is also a comment/*
multiline
comment
*/
Her er forskellen mellem kommentarerne på én linje og flere linier:
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;
Her er endnu et eksempel på en kommentar med flere linjer:
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;
Kommentering ved hjælp af #-symbolet
Den grundlæggende hash-kommentar stil kan indsættes i tekst som denne:
Select * from users ; # this will list usersKommentering ved hjælp af dobbeltstreg (–)
Dette er mere eller mindre det samme (glem ikke pladsen). Standard SQL kræver faktisk ikke, at du bruger pladsen der, men MySQL bruger den til at undgå problemer med kommandoer som SELECT 10–1.
Select * from users ; -- this will list usersKommentering ved hjælp af / * og * / symbolerne
Denne flerlinjekommentar behøver, i modsætning til de to foregående eksempler, ikke at stoppe for enden af linjen.
Select * from users ; /* this will list users */Eksekverbare kommentarer
Som regel ignoreres kommentarer af alle, der er i den anden ende (fordi de kun er for programmører), men nogle kommentartyper – eksekverbare kommentarer – aktiverer koden, der kører på nogle systemer.
I vores tilfælde giver eksekverbare kommentarer dig mulighed for at bruge SQL-koder, der kun vil blive udført i MYSQL, ikke i andre databaser.
Eksekverbare kommentarer skal være indeholdt i asteriske skråstreger , som med den sædvanlige kode:
/*! MySQL-specifik kode */
Disse eksekverbare kommentarer kræver dog en specifik syntaks som nedenfor:
/*!##### MySQL-specifik kode */
Du skal bruge !##### del for at signalere eksekverbare kommentarer. Det repræsenterer minimumsversionen af MYSQL, der kan udføre kommentarer.
I stedet for den første hash skal du erstatte hovedversionen af MYSQL. I stedet for den anden erstattes de sidste 2 med den yngre version og versionerne af patchen.
Kun MySQL 5.1.10 eller nyere version kan køre følgende kommentarer:
CREATE TABLE t1 (
k INT AUTO_INCREMENT,
KEY (k)
) /*!50110 KEY_BLOCK_SIZE=1024; */
Konklusion
Kommentarer gør programmer lettere at læse ved at tilføje flere detaljer. Du kan tænke på dem som noget, der ligner hash - de reducerer den tid, der kræves for at forstå koden eller identificerer nogle dele af den drastisk ved at levere uddrag, der fanger essensen af teksten. Hvis du nogensinde har arbejdet med nul-viden beviser eller forsøgt at logge ind på Facebook via Google, ved du, hvad vi mener.
Derfor er det vigtigt at kommentere din kode og vide, hvordan du gør det korrekt. At holde din kode nøjagtig med informative noter gør livet lettere for alle involverede specialister.