Selles õpetuses saate teada JavaScripti kommentaaridest, miks peaksite neid kasutama ja kuidas neid näidete abil kasutada.
JavaScripti kommentaarid on näpunäited, mida programmeerija saab lisada, et muuta nende kood hõlpsamini loetavaks ja arusaadavaks. JavaScripti mootorid ignoreerivad neid täielikult.
Koodile kommentaaride lisamiseks on kaks võimalust:
//- Üherealised kommentaarid/* */-Mitu rida kommentaare
Ühe rea kommentaarid
JavaScripti puhul on iga algav //rida ühe rea kommentaar. Näiteks,
name = "Jack"; // printing name on the console console.log("Hello " + name);
Siin // printing name on the consoleon kommentaar.
Võite kasutada ka ühe rea kommentaare järgmiselt:
name = "Jack"; console.log("Hello " + name); // printing name on the console
Mitmerealised kommentaarid
Javascriptis on suvaline /*ja */mitmerealine kommentaar teksti vahel . Näiteks,
/* 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. */
Kuna ülejäänud lähtekoodi kasutatakse mängureeglite rakendamiseks, on ülaltoodud kommentaar hea näide, kus võite kasutada mitmerealist kommentaari.
Kommentaaride kasutamine silumiseks
Kommentaare saab kasutada ka koodi keelamiseks, et vältida selle käivitamist. Näiteks,
console.log("some code"); console.log("Error code); console.log("other code");
Kui saate programmi käivitamisel tõrke, saate veaohtliku koodi eemaldamise asemel selle käivitamise keelata kommentaaridega; see võib olla väärtuslik silumisvahend.
console.log("some code"); // console.log("Error code); console.log("other code");
Pro näpunäide: pidage meeles kommentaaride kasutamise otseteed; see võib olla tõesti kasulik. Enamiku koodiredaktorite jaoks on see Ctrl + /mõeldud Windowsi ja Cmd + /Maci jaoks.
Muuda kood arusaadavamaks
JavaScripti arendajana ei kirjuta te ainult koodi, vaid peate võib-olla muutma ka teiste arendajate kirjutatud koodi.
Kui kirjutate oma koodile kommentaare, on teil edaspidi lihtsam koodist aru saada. Samuti on teistel arendajatel lihtsam koodi mõista.
Üldise rusikareeglina selgitage kommentaaride abil, miks te midagi tegite, mitte seda, kuidas te midagi tegite, ja teil on hea.
Märkus. Kommentaarid ei tohiks asendada viisi, kuidas seletada halvasti kirjutatud koodi inglise keeles. Alati tuleks kirjutada hästi struktureeritud ja iseenesestmõistetav kood. Ja siis kasutage kommentaare.
