V tej vadnici boste izvedeli več o komentarjih JavaScript, zakaj bi jih morali uporabljati in kako jih uporabiti s pomočjo primerov.
Komentarji JavaScript so namigi, ki jih lahko doda programer, da olajša branje in razumevanje njihove kode. Stroji JavaScript jih popolnoma prezrejo.
Pripombe kodi lahko dodate na dva načina:
//- Enovrstni komentarji/* */-Večvrstični komentarji
Enovrstični komentarji
V JavaScript je katera koli vrstica, ki se začne, //en komentar v eni vrstici. Na primer
name = "Jack"; // printing name on the console console.log("Hello " + name);
Tukaj // printing name on the consoleje komentar.
Lahko uporabite tudi enovrstni komentar, kot je ta:
name = "Jack"; console.log("Hello " + name); // printing name on the console
Komentarji z več vrsticami
V Javascriptu je vsako besedilo med /*in */večvrstični komentar. Na primer
/* 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. */
Ker bo preostala izvorna koda uporabljena za izvajanje pravil igre, je zgornji komentar dober primer, ko lahko uporabite večvrstični komentar.
Uporaba komentarjev za odpravljanje napak
Komentarji se lahko uporabljajo tudi za onemogočanje kode, da se prepreči njeno izvajanje. Na primer
console.log("some code"); console.log("Error code); console.log("other code");
Če se med zagonom programa prikaže napaka, lahko namesto odstranitve kode, ki je nagnjena k napakam, s pomočjo komentarjev onemogočite njeno izvajanje; to je lahko dragoceno orodje za odpravljanje napak.
console.log("some code"); // console.log("Error code); console.log("other code");
Nasvet za profesionalce: zapomnite si bližnjico za uporabo komentarjev; lahko je resnično koristno. Za večino urejevalnikov kod je to Ctrl + /za Windows in Cmd + /Mac.
Naj bo koda enostavnejša za razumevanje
Kot razvijalec JavaScripta ne boste le pisali kode, ampak boste morda morali tudi spremeniti kodo, ki so jo napisali drugi razvijalci.
Če na svojo kodo pišete komentarje, jo boste v prihodnosti lažje razumeli. Prav tako bodo vaši kolegi razvijalci lažje razumeli kodo.
Kot splošno pravilo uporabite komentarje, da razložite, zakaj ste nekaj storili, ne pa kako ste nekaj naredili in ste dobri.
Opomba: Komentarji ne smejo nadomestiti načina razlage slabo napisane kode v angleščini. Vedno morate napisati dobro strukturirano in samoumevno kodo. In nato uporabite komentarje.
