Комментарии
Определение и применение
Комментарий — фрагмент исходного кода, содержимое которого JavaScript не выполняет. Рядом с инструкцией в комментарии
поясняют, почему она нужна. Перед функцией описывают её параметры и результат, а в начале файла часто указывают
правообладателя и лицензию, например /* SPDX-License-Identifier: MIT */.
При отладке комментарии помогают временно отключить часть кода. Например, если поставить // в начале
строки с вызовом sendEmail();, можно проверить остальной код без вызова этой функции.
Объяснение на задачах — в уроке учебника «Инструкции и комментарии».
Поддержка браузерами
Спецификация: ecma262
Поддерживается во всех основных браузерах с 2020 года.
| Возможность | Компьютеры | Мобильные | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Hashbang (#!) comment syntax | 74 | 79 | 67 | 62 | 13.1 | 74 | 67 | 53 | 13.4 | 11.0 | 74 | 13.4 |
поддерживаетсяс ограниченияминет поддержкинет данных≤31 — не позднее версии 31
Виды комментариев
| Запись | Назначение |
|---|---|
// текст |
до конца строки |
/* текст */ |
любой длины, можно внутри строки кода, вкладывать нельзя |
/** @param {number} price */ |
JSDoc: описание функции для редактора и инструментов |
#!/usr/bin/env node |
hashbang только с самого начала исходного текста, без пробелов перед #!. Оболочка может
использовать его для выбора программы запуска, JavaScript воспринимает его как комментарий
|
Вложенный /* … /* … */ … */ закончится на первом */, а остаток станет кодом с ошибкой.
Последовательность */ внутри открытого блочного комментария закроет его даже между кавычками: строки
внутри комментария не разбираются. В обычном строковом литерале вне комментария "*/" безопасна.
Комментарий с переводом строки влияет на грамматику: return /* перевод строки */ value при настоящем
переносе внутри комментария ведёт себя как return на отдельной строке. Если переноса нет, значение
возвращается. Подробности —
ASI. JSDoc — обычный
блочный комментарий для языка, его типы сами по себе не проверяют аргументы во время выполнения.
В старых классических браузерных скриптах встречаются HTML-подобные комментарии <!-- и
-->, у закрывающей формы есть ограничения положения в строке. В модулях эти формы запрещены. В новом
коде используйте // или /* */. Внутри HTML-элемента <script> буквальная
последовательность </script> может закрыть элемент даже в JavaScript-комментарии или строке:
сначала HTML разбирает браузерный парсер.
Примеры
Комментарии и JSDoc
Вывод: 108 — комментарии не влияют на выполнение. Измените процент скидки на отрицательное число: защита в коде оставит исходную цену.
index.html
<html lang="ru">
<head>
<meta charset="utf-8">
<title>Комментарии и JSDoc</title>
</head>
<body>
<script src="main.js"></script>
</body>
</html>
main.js
/**
* Цена со скидкой.
* @param {number} price — цена в рублях
* @param {number} percent — скидка в процентах
*/
function salePrice(price, percent) {
// Скидка не может быть отрицательной: так решили в акции.
return price - (price * Math.max(percent, 0)) / 100; /* округление — при выводе */
}
console.log(salePrice(120, 10));
Нажмите , чтобы запустить пример.
Перевод строки внутри комментария
Вывод: 120, затем undefined. Перенос в блочном комментарии участвует в ASI. Уберите перенос между /* и */ во второй функции: обе функции вернут 120.
index.html
<html lang="ru">
<head>
<meta charset="utf-8">
<title>Перевод строки внутри комментария</title>
</head>
<body>
<script src="main.js"></script>
</body>
</html>
main.js
function sameLine() {
return /* цена */ 120;
}
function nextLine() {
return /* цена
*/ 120;
}
console.log(sameLine());
console.log(nextLine());
Нажмите , чтобы запустить пример.