V tomto výukovém programu se dozvíte o komentářích v jazyce JavaScript, proč byste je měli používat a jak je používat pomocí příkladů.
Komentáře v JavaScriptu jsou rady, které může programátor přidat, aby jejich kód byl lépe čitelný a srozumitelný. Jsou zcela ignorovány motory JavaScriptu.
Existují dva způsoby, jak přidat komentáře ke kódu:
//- Jednořádkové komentáře/* */-Víceřádkové komentáře
Jednořádkové komentáře
V JavaScriptu je každý řádek, který začíná, //jedním komentářem. Například,
name = "Jack"; // printing name on the console console.log("Hello " + name);
Zde // printing name on the consoleje komentář.
Můžete také použít jeden řádek, jako je tento:
name = "Jack"; console.log("Hello " + name); // printing name on the console
Víceřádkové komentáře
Ve Javascriptu je jakýkoli text mezi /*a */víceřádkový komentář. Napří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. */
Protože zbytek zdrojového kódu bude použit k implementaci pravidel hry, výše uvedený komentář je dobrým příkladem, kde můžete použít víceřádkový komentář.
Používání komentářů k ladění
Komentáře lze také použít k deaktivaci kódu, aby se zabránilo jeho spuštění. Například,
console.log("some code"); console.log("Error code); console.log("other code");
Pokud se vám při spuštění programu zobrazí chyba, můžete místo odstranění kódu náchylného k chybám zakázat jeho provádění pomocí komentářů; to může být cenný nástroj pro ladění.
console.log("some code"); // console.log("Error code); console.log("other code");
Profesionální tip: Pamatujte si zkratku pro používání komentářů; může to být opravdu užitečné. Pro většinu editorů kódu je to Ctrl + /pro Windows a Cmd + /Mac.
Usnadněte pochopení kódu
Jako vývojář JavaScriptu budete nejen psát kód, ale možná budete muset upravit i kód napsaný jinými vývojáři.
Pokud ke svému kódu napíšete komentáře, bude pro vás v budoucnu kódu snazší porozumět. Pro ostatní vývojáře bude také snazší porozumět kódu.
Obecným pravidlem je, že pomocí komentářů vysvětlete, proč jste něco udělali, spíše než to, jak jste něco udělali, a jste dobří.
Poznámka: Komentáře by neměly nahrazovat způsob, jak vysvětlit špatně napsaný kód v angličtině. Vždy byste měli psát dobře strukturovaný a vysvětlující kód. A pak použijte komentáře.
