Комментарии в JS
В это статье вы узнаете, что такое комментарии JavaScript, зачем они нужны и как их использовать.
Комментарии — это текстовые подсказки, которые оставляет программист в коде. Комментарии делают код более читабельным и легким для понимания. Движки JavaScript игнорируют комментарии — они нужны для людей.
В JavaScript два типа комментариев:
- однострочные комментарии:
//
; - многострочные комментари:
/* */
.
Однострочные комментарии
В JavaScript любая строчка, начинающаяся с //
, является однострочным комментарием.
Например, здесь, // выводит приветствие в консоль
— однострочный комментарий, который объясняет, что делает строчка ниже.
name = "Андрей";
// выводит приветствие в консоль
console.log("Привет, " + name);
Однострочные комментарии можно использовать и на одной строчке с кодом:
name = "Андрей";
console.log("Привет, " + name); // выводит имя в консоль
Многострочные комментарии
В Javascript любой текст между /*
и */
является многострочным комментарием.
Допустим, мы написали игру. Хорошей идеей будет оставить комментарий до основного кода, который объясняет, что это за игра, как в неё играть и так далее. Для этого удобно использовать многострочный комментарий.
/* Это исходный код игры «Стрельба по мишени».
Есть мишень, у которой имеется 7 концентрических кругов. Круги идут с шагом 1.
Попадание в центральный круг 10 очков, далее от центра каждый последующий круг на 1 меньше.
Попадание за пределы последнего круга не приносит очков — попадание в «молоко».
На каждом следующем шаге количество полученных за очередной выстрел очков добавляется к общей сумме.
Игра продолжается пока пользователь не захочет ее остановить (ввод Y ).
*/
Комментарии для отладки
С помощью комментариев можно временно «отключать» куски кода, чтобы они не выполнялись. Например, если вы подозреваете, что в каком-то месте есть ошибка, и хотите проверить работу программы без потенциально неправильного куска кода, — его можно закомментировать.
console.log("Какой-то код");
console.log("Код с ошибкой: пропущена кавычка);
console.log("Ещё какой-то код");
Например, в примере выше у нас пропущена кавычка, которая должна закрывать строку. Из-за этого программа работать не будет и выдаст ошибку. Если строку с ошибкой закомментировать, тогда всё заработает.
console.log("Какой-то код");
// console.log("Код с ошибкой: пропущена кавычка);
console.log("Какой-то код");
Совет. Чтобы быстро оставить однострочный комментарий, используйте сочетание горячих клавиш. Для Windows: Ctrl + /. Для Mac: Cmd + /.
Зачем писать комментарии
Разработчики пишут код не только для себя. Часто им приходится работать с чужим кодом: например, если разработчик ушел, а продукт нужно дальше пилить.
К коду нужно писать комментарии, чтобы ваши коллеги и вы из будущего смогли понять, что делает эта программа и зачем она нужна. То, как она работает, указывать необязательно — об это должен говорить сам код.
Совет. Нельзя написать плохой код и потом объяснить, как он работает, с помощью комментариев. Пишите сразу структурированный и понятный код, который можно понять без комментариев. Комментарии нужны, чтобы объяснить, зачем этот код.