LearnJS

Комментарии в JavaScript

В JavaScript можно оставлять комментарии. Это обычный текст внутри кода, который нужен человеку, но не выполняется браузером.

Комментарии помогают объяснить, что делает код, оставить заметку на будущее или временно отключить строку во время проверки. Для новичка это особенно полезно: можно подписывать непонятные места и постепенно лучше разбираться в программе.

Что такое комментарии

Комментарий - это часть кода, которую JavaScript пропускает. Браузер видит комментарий, но не пытается его выполнить как команду.

Например:

// Это комментарий
console.log('Скрипт работает');

Первая строка нужна только нам. Вторая строка уже является JavaScript-кодом и будет выполнена. В консоли появится сообщение:

Скрипт работает

Комментарии не выводятся на страницу и не появляются в консоли сами по себе. Они просто остаются в файле как пояснение.

Однострочные комментарии

Однострочный комментарий начинается с двух слешей //. Все, что написано после них в этой же строке, будет проигнорировано JavaScript.

// Выводим сообщение в консоль
console.log('Привет, JavaScript!');

Комментарий можно написать и после команды:

console.log(10 + 5); // 15

Так часто подписывают результат примера. Это удобно в обучающих материалах, когда нужно сразу показать, что получится после выполнения кода.

Но важно помнить: комментарий после // работает только до конца строки.

console.log('Первая строка'); // комментарий
console.log('Вторая строка');

В этом примере вторая строка выполнится, потому что она уже находится на новой строке и не относится к комментарию.

Многострочные комментарии

Если нужно оставить большой комментарий на несколько строк, используют запись /* … */.

/*
  Этот комментарий занимает
  несколько строк
*/

console.log('Код после комментария');

Все, что находится между /* и */, браузер пропустит.

Многострочные комментарии удобно использовать для более длинных пояснений. Например, перед сложным участком кода или временной заметкой.

/*
  Здесь позже добавим проверку формы:
  имя пользователя,
  email,
  текст сообщения.
*/

На первых уроках чаще всего хватает обычных комментариев через //. Многострочный вариант пригодится, когда пояснение занимает больше одной строки.

Как временно отключить код

Комментарии часто используют не только для пояснений, но и для временного отключения кода. Такой прием называют “закомментировать код”.

console.log('Первая строка');
// console.log('Вторая строка');
console.log('Третья строка');

В этом примере вторая строка не выполнится. В консоли появятся только первая и третья строки.

Первая строка
Третья строка

Это удобно, когда нужно быстро проверить, какая часть программы влияет на результат. Закомментировали строку, обновили страницу, посмотрели поведение.

В редакторе кода обычно есть горячая клавиша для комментирования. В VS Code это Ctrl + /. Если выделить несколько строк и нажать это сочетание, редактор сам добавит или уберет комментарии.

Как писать полезные комментарии

Комментарии должны помогать читать код. Не нужно подписывать каждую очевидную строку. Если комментариев слишком много, они начинают мешать.

Не самый полезный комментарий:

let age = 18; // Создаем переменную age со значением 18

Здесь комментарий просто повторяет код. Лучше оставить пояснение, которое объясняет смысл:

let minAge = 18; // Минимальный возраст для регистрации

Хорошие комментарии обычно объясняют:

  • почему код написан именно так;
  • что нужно доделать позже;
  • какой результат ожидается в примере;
  • какой участок кода временно отключен;
  • что может быть непонятно при первом чтении.

В учебных примерах комментариев может быть больше, чем в рабочем проекте. Это нормально: пока мы учимся, пояснения помогают быстрее связать команду и результат.

Что дальше

Теперь мы знаем, как оставлять комментарии в JavaScript и временно отключать строки кода. Это простой инструмент, но он сильно помогает при обучении и отладке.

Дальше разберем ошибки в JavaScript: почему они появляются, как их читать в консоли и что делать, если код не запускается.