У цьому підручнику ви дізнаєтесь про коментарі 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, ви не тільки будете писати код, але також, можливо, доведеться змінити код, написаний іншими розробниками.
Якщо ви будете писати коментарі до свого коду, вам буде легше зрозуміти його в майбутньому. Крім того, вашим колегам-розробникам буде простіше зрозуміти код.
Як загальне правило, використовуйте коментарі, щоб пояснити, чому ви щось зробили, а не те, як щось зробили, і ви добре.
Примітка: Коментарі не повинні замінювати спосіб пояснення погано написаного коду англійською мовою. Слід завжди писати добре структурований та зрозумілий код. А потім використовуйте коментарі.
