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

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

Давайте рассмотрим два основных вида комментариев:

Однострочные комментарии начинаются с двойной косой черты //

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

// Этот комментарий занимает всю строку
alert('Hello');
alert('Horse'); // Этот комментарий следует за инструкцией

Многострочные комментарии начинаются косой чертой со звёздочкой /* и заканчиваются звёздочкой с косой чертой */

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

/* Пример с двумя сообщениями.
Это - многострочный комментарий.
*/
alert('Hello');
alert('Horse');

Содержимое комментария игнорируется движком JavaScript, поэтому код внутри /* … */ не будет исполняться. Это может быть полезно, например, для временного отключения участка кода:

/* Закомментировали код
alert('Привет');
*/
alert('Мир');

Используйте комбинации клавиш в вашем редакторе для комментирования кода. Например, в большинстве редакторов Ctrl+/ для однострочного комментария и что-то вроде Ctrl+Shift+/ для многострочных комментариев (выделите кусок кода и нажмите комбинацию клавиш). В системе Mac используйте Cmd вместо Ctrl и Option вместо Shift.

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

/*
 /* вложенный комментарий ?!? */
*/
alert('Мир');

Заключение

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