Комментарии используются для пояснения JavaScript кода, чтобы сделать его более понятным.
Также, комментарии позволяют закрыть отдельные участки JavaScript кода от выполнения во время тестирования альтернативных алгоритмов.
Однострочные комментарии
Чтобы определить однострочный комментарии, необходимо перед текстом комментария написать двойной прямой слэш (//). Любой текст между двойным слэшем (//) и концом строки будет игнорироваться (не будет выполняться) обработчиком JavaScript.
В следующем примере перед каждой строкой кода определяется однострочный комментарий:
// Изменим заголовок:
document.getElementById("myH").innerHTML = "Моя первая веб-страница";
// Изменим параграф:
document.getElementById("myP").innerHTML = "Мой первый параграф.";
В следующем примере одностроччный комментарий используется в конце каждой строки для пояснения JavaScript кода:
var x = 5; // Декларируем переменную x и присваиваем ей значение 5
var y = x + 2; // Декларируем переменную y и присваиваем ей значение x + 2
Многострочные комментарии
Для определения многострочного комментария используется конструкция /*...*/. Любой текст, находящийся между /* и */ будет игнорироваться обработчиком JavaScript.
В следующем примере используется многострочный комментарий (блок комментария) для пояснения JavaScript кода:
/*
Код ниже изменит
на моей веб-странице
заголовок с id = "myH"
и параграф с id = "myP":
*/
document.getElementById("myH").innerHTML = "Моя первая веб-страница";
document.getElementById("myP").innerHTML = "Мой первый параграф.";
Как правило, чаще используют однострочные комментарии. Блоки комментариев обычно используются для официальной документации.
Использование комментариев, чтобы закрыть код от выполнения
Для того чтобы протестировать работу скрипта, очень удобно закрывать определенные участки кода при помощи комментариев, проверяя различные альтернативы.
Добавление слэшей // перед строкой кода сделает его неисполняемым и превратит в комментарий.
В следующем примере слэши // используются, чтобы закрыть от выполнения одну из строк кода:
//document.getElementById("myH").innerHTML = "Моя первая веб-страница";
document.getElementById("myP").innerHTML = "Мой первый параграф.";
В следующем примере блок комментариев используется, чтобы закрыть от выполнения сразу несколько строк кода:
/*
document.getElementById("myH").innerHTML = "Моя первая веб-страница";
document.getElementById("myP").innerHTML = "Мой первый параграф.";
*/
