In deze zelfstudie leert u aan de hand van voorbeelden over JavaScript-opmerkingen, waarom u ze zou moeten gebruiken en hoe u ze kunt gebruiken.
JavaScript-opmerkingen zijn hints die een programmeur kan toevoegen om hun code gemakkelijker leesbaar en begrijpelijk te maken. Ze worden volledig genegeerd door JavaScript-engines.
Er zijn twee manieren om opmerkingen aan code toe te voegen:
//- Enkele regel opmerkingen/* */-Multi-line opmerkingen
Enkele regel opmerkingen
In JavaScript is elke regel die begint met //een enkele regel commentaar. Bijvoorbeeld,
name = "Jack"; // printing name on the console console.log("Hello " + name);
Hier // printing name on the consoleis een opmerking.
U kunt ook als volgt commentaar van één regel gebruiken:
name = "Jack"; console.log("Hello " + name); // printing name on the console
Opmerkingen met meerdere regels
In Javascript is elke tekst tussen /*en */een commentaar van meerdere regels. Bijvoorbeeld,
/* The following program contains the source code for a game called Baghchal. Baghchal is a popular board game in Nepal where two players choose either sheep or tiger. It is played on a 5x5 grid. For the player controlling the tiger to win, they must capture all the sheep. There are altogether 4 tigers on the board. For the sheep to win, all tigers must be surrounded and cornered so that they cannot move. The player controlling the sheep has 20 sheep at his disposal. */
Aangezien de rest van de broncode zal worden gebruikt om de regels van het spel te implementeren, is de bovenstaande opmerking een goed voorbeeld waarbij je een opmerking uit meerdere regels kunt gebruiken.
Opmerkingen gebruiken voor foutopsporing
Opmerkingen kunnen ook worden gebruikt om code uit te schakelen om te voorkomen dat deze wordt uitgevoerd. Bijvoorbeeld,
console.log("some code"); console.log("Error code); console.log("other code");
Als u een foutmelding krijgt tijdens het uitvoeren van het programma, in plaats van de foutgevoelige code te verwijderen, kunt u opmerkingen gebruiken om de uitvoering ervan uit te schakelen; dit kan een waardevol hulpmiddel voor foutopsporing zijn.
console.log("some code"); // console.log("Error code); console.log("other code");
Pro-tip: onthoud de snelkoppeling voor het gebruik van opmerkingen; het kan heel nuttig zijn. Voor de meeste code-editors is het Ctrl + /voor Windows en Cmd + /Mac.
Maak code gemakkelijker te begrijpen
Als JavaScript-ontwikkelaar schrijft u niet alleen code, maar moet u mogelijk ook code wijzigen die door andere ontwikkelaars is geschreven.
Als u opmerkingen over uw code schrijft, zult u de code in de toekomst gemakkelijker begrijpen. Het zal ook gemakkelijker zijn voor uw mede-ontwikkelaars om de code te begrijpen.
Gebruik als algemene vuistregel opmerkingen om uit te leggen waarom je iets hebt gedaan in plaats van hoe je iets hebt gedaan, en je bent goed.
Opmerking: opmerkingen mogen geen vervanging zijn voor een manier om slecht geschreven code in het Engels uit te leggen. U moet altijd een goed gestructureerde en voor zichzelf sprekende code schrijven. En gebruik dan opmerkingen.
