V tomto výučbe sa dozviete o komentároch k JavaScriptu, o tom, prečo by ste ich mali používať, a ako ich používať pomocou príkladov.
Komentáre JavaScriptu sú rady, ktoré môže pridať programátor, aby bol ich kód ľahšie čitateľný a pochopiteľný. Prehliadače JavaScript ich úplne ignorujú.
Existujú dva spôsoby, ako pridať komentáre ku kódu:
//- Jednoriadkové komentáre/* */-Viacriadkové komentáre
Jednoriadkové komentáre
V JavaScripte je každý riadok, ktorý začína, //jednoriadkovým komentárom. Napríklad,
name = "Jack"; // printing name on the console console.log("Hello " + name);
Tu // printing name on the consoleje komentár.
Môžete tiež použiť jeden riadok, ako je tento:
name = "Jack"; console.log("Hello " + name); // printing name on the console
Viacriadkové komentáre
V Javascripti je akýkoľvek text medzi /*a */viacriadkový komentár. Napríklad,
/* 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. */
Pretože zvyšok zdrojového kódu bude použitý na implementáciu pravidiel hry, vyššie uvedený komentár je dobrým príkladom, keď môžete použiť viacriadkový komentár.
Používanie komentárov na ladenie
Komentáre možno použiť aj na deaktiváciu kódu, aby sa zabránilo jeho vykonaniu. Napríklad,
console.log("some code"); console.log("Error code); console.log("other code");
Ak sa vám pri spustení programu vyskytne chyba, môžete namiesto odstránenia kódu náchylného na chyby vykonať jeho vykonanie pomocou komentárov; toto môže byť cenný nástroj na ladenie.
console.log("some code"); // console.log("Error code); console.log("other code");
Pro Tip: Nezabudnite na skratku na používanie komentárov; môže to byť naozaj užitočné. Pre väčšinu editorov kódu je to Ctrl + /pre Windows a Cmd + /Mac.
Uľahčite pochopenie kódu
Ako vývojár JavaScriptu budete nielen písať kód, ale možno budete musieť upraviť aj kód napísaný inými vývojármi.
Ak k svojmu kódu napíšete komentár, v budúcnosti mu ľahšie porozumiete. Pre vašich kolegov vývojárov bude tiež jednoduchšie porozumieť kódu.
Ako všeobecné pravidlo platí, že pomocou komentárov vysvetlite, prečo ste niečo urobili, a nie to, ako ste niečo urobili, a ste dobrí.
Poznámka: Komentáre by nemali byť náhradou za spôsob vysvetlenia zle napísaného kódu v angličtine. Vždy by ste mali napísať dobre štruktúrovaný a vysvetľujúci kód. A potom použite komentáre.
