Hoe u optimaal gebruik kunt maken van de commentaarfunctie in MySQL

Opmerkingen worden gebruikt om informatie aan de code toe te voegen. Het wordt meestal genegeerd door de compiler, maar menselijke specialisten kunnen die opmerkingen lezen wanneer ze uw code bekijken. Opmerkingen zijn essentieel voor ontwikkelaars omdat ze beperkte tijd hebben, en commentaar stelt hen in staat om meteen waardevolle informatie te krijgen of om enkele cruciale details met betrekking tot de code op te merken. Door toegang te krijgen tot deze gegevens kunnen ze de juiste beslissingen nemen en sneller werken.

Hoe kan commentaar voor mij nuttig zijn?

Opmerkingen zijn nuttig voor u persoonlijk en voor iedereen die deze code later misschien moet lezen of bewerken. Maar hoe precies?

Opmerkingen kunnen tijdelijke aanduidingen zijn bij het coderen. Op dat moment zou je iets kunnen aannemen en zou je in de toekomst weten of je aanname waar is.

Opmerkingen kunnen uw gedachten documenteren of notities voor uzelf zijn, zodat u uw handelingen niet vergeet als u er later op terugkomt.

Je kunt opmerkingen over wat je hebt gedaan in je code opnemen zodat andere programmeurs het beter en sneller begrijpen (de tijd van de programmeur is erg, erg duur).

Je kunt opmerkingen gebruiken om buggy-onderdelen tijdelijk uit of in te schakelen.

Reageren op elke regel van een script maakt het eenvoudiger om bij te houden waar bugs in het programma kunnen zitten.

Opmerkingen kunnen uitleggen wat bepaalde coderegels doen, of waarom je een bepaalde aanpak hebt gekozen om misverstanden te voorkomen (bijvoorbeeld wanneer sommige delen van de code bedoeld zijn voor een bepaalde sectie of het specifieke doel dat je duidelijk moet begrijpen) ,

Je kunt een hele paragraaf schrijven waarin alle details over de codesectie worden uitgelegd, indien nodig voor nieuwelingen of mensen van andere projecten. Commentaar is vaak nodig bij het schrijven van complexe SQL-query's met veel clausules zoals INNER JOIN's, GROUP BY's, enz.

Met opmerkingen kun je aantekeningen maken over wat je aan het doen bent. Dit helpt anderen te begrijpen hoe en waarom je iets hebt gedaan, zodat ze het kunnen onderhouden of aanpassen als dat nodig is.

Is SQL een goede taal voor opmerkingen?

Ja! Opmerkingen worden meestal gebruikt in combinatie met talen zoals SQL en PHP, waar we ze in een tekstbestand of script kunnen invoegen met behulp van de commentaarfunctie * / (bijv. /* Dit is mijn opmerking */). Ze zijn doorgaans ook net zo gemakkelijk ergens anders te gebruiken.

Hoe commentaar geven in SQL?

Met de commentaarfunctie kunt u elke tekst schrijven om een opmerking in SQL toe te voegen. Het heeft geen invloed op de uiteindelijke uitvoer zolang deze voor of na een bepaald voorgeprogrammeerd teken komt.

Om opmerkingen in SQL toe te voegen, kunt u de volgende symbolen gebruiken:/* */ of # of — (dubbel streepje).

/* */ werkt voor elke situatie waarin u uw opmerking op dat moment wilt beginnen en beëindigen zonder iets anders te gebruiken (zoals enkele aanhalingstekens).

# wordt gebruikt voor één regel code tegelijk

— geldt ook voor één coderegel tegelijk. Vergeet niet een spatie achter dit dubbele streepje te plaatsen.

In uw code zou het er als volgt uitzien:

-- this is a comment

# this is also a comment

/*
   multiline
   comment
*/

Hier is het verschil tussen de eenregelige en meerregelige opmerkingen:

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;

Hier is nog een voorbeeld van een opmerking met meerdere regels:

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;

Reageren met het #-symbool

De basis hash-commentaar stijl kan als volgt in tekst worden ingevoegd:

Select * from users ; # this will list users

Reageren met het dubbele streepje (–)

Dit is min of meer hetzelfde (vergeet de spatie niet). De standaard SQL vereist niet dat je de ruimte daar gebruikt, maar MySQL gebruikt het om problemen met commando's zoals SELECT 10-1 te voorkomen.

Select * from users ; -- this will list users

Reageren met de / * en * / symbolen

Deze meerregelige opmerking hoeft, in tegenstelling tot de vorige twee voorbeelden, niet te stoppen aan het einde van de regel.

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

Uitvoerbare opmerkingen

In de regel worden opmerkingen genegeerd door iedereen aan de andere kant (omdat ze alleen voor programmeurs zijn), maar sommige typen opmerkingen - uitvoerbare opmerkingen - zorgen ervoor dat de code op sommige systemen wordt uitgevoerd.

In ons geval kunt u met uitvoerbare opmerkingen SQL-codes gebruiken die alleen in MYSQL worden uitgevoerd, niet in andere databases.

Uitvoerbare opmerkingen moeten tussen slashes met sterretjes staan , zoals bij de gebruikelijke code:

/*! MySQL-specifieke code */

Deze uitvoerbare opmerkingen vereisen echter een specifieke syntaxis zoals hieronder:

/*!##### MySQL-specifieke code */

Je hebt de !##### . nodig deel om uitvoerbare opmerkingen te signaleren. Het vertegenwoordigt de minimale versie van MYSQL die commentaren kan uitvoeren.

Vervang de hoofdversie van MYSQL in plaats van de eerste hash. In plaats van de tweede worden de jongere versie en de versies van de patch vervangen door de laatste 2.

Alleen MySQL 5.1.10 of latere versie kan de volgende opmerkingen uitvoeren:

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

Conclusie

Opmerkingen maken programma's leesbaarder door meer details toe te voegen. Je kunt ze beschouwen als enigszins vergelijkbaar met hashes - ze verminderen de tijd die nodig is om de code te begrijpen of sommige delen ervan drastisch te identificeren door fragmenten te bieden die de essentie van de tekst vastleggen. Als je ooit met zero-knowledge proofs hebt gewerkt of hebt geprobeerd in te loggen op Facebook via Google, weet je wat we bedoelen.

Daarom is het essentieel om commentaar te geven op uw code en te weten hoe u dit correct moet doen. Door uw code nauwkeurig te houden met informatieve notities, wordt het leven van alle betrokken specialisten gemakkelijker.