В този урок ще научите за коментарите в JavaScript, защо трябва да ги използвате и как да ги използвате с помощта на примери.
Коментарите на JavaScript са подсказки, които програмист може да добави, за да направи кода им по-лесен за четене и разбиране. Те са напълно игнорирани от JavaScript двигателите.
Има два начина за добавяне на коментари към кода:
//- Едноредови коментари/* */-Многоредови коментари
Едноредови коментари
В JavaScript всеки ред, който започва с, //е едноредов коментар. Например,
name = "Jack"; // printing name on the console console.log("Hello " + name);
Ето // printing name on the consoleкоментар.
Можете също да използвате едноредов коментар по следния начин:
name = "Jack"; console.log("Hello " + name); // printing name on the console
Многоредови коментари
В Javascript всеки текст между /*и */е многоредов коментар. Например,
/* 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. */
Тъй като останалата част от изходния код ще бъде използвана за прилагане на правилата на играта, коментарът по-горе е добър пример, когато можете да използвате многоредов коментар.
Използване на коментари за отстраняване на грешки
Коментарите могат да се използват и за деактивиране на кода, за да се предотврати изпълнението му. Например,
console.log("some code"); console.log("Error code); console.log("other code");
Ако получите грешка, докато стартирате програмата, вместо да премахнете склонния към грешки код, можете да използвате коментари, за да го деактивирате от изпълнение; това може да бъде ценен инструмент за отстраняване на грешки.
console.log("some code"); // console.log("Error code); console.log("other code");
Професионален съвет: Не забравяйте пряк път за използване на коментари; може да бъде наистина полезно. За повечето редактори на кодове това е Ctrl + /за Windows и Cmd + /за Mac.
Направете кода по-лесен за разбиране
Като разработчик на JavaScript, вие не само ще пишете код, но може да се наложи и да модифицирате код, написан от други разработчици.
Ако пишете коментари за вашия код, ще ви бъде по-лесно да разберете кода в бъдеще. Също така ще бъде по-лесно за вашите колеги разработчици да разберат кода.
Като общо правило използвайте коментари, за да обясните защо сте направили нещо, а не как сте направили нещо и сте добри.
Забележка: Коментарите не трябва да заместват начина за обяснение на лошо написания код на английски език. Винаги трябва да пишете добре структуриран и обяснителен код. И след това използвайте коментари.
