Как правильно писать комментарии в JavaScript?
Глупый, наверное, вопрос, но всё же. Хочу оставлять пометки в коде для себя, но не знаю, как пишутся комментарии в js.
Видел и //, и /* */ — в чём между ними разница и когда какой использовать? И правда ли, что комментарии вообще не влияют на работу программы?
2 ответа
Не глупый вопрос, всё нормально. Да, комментарии полностью игнорируются движком — это заметки для людей, на работу кода они не влияют.
В JS есть два вида:
Однострочный — через //. Всё, что после // до конца строки, — комментарий:
// это пояснение к строке ниже
let price = 100;
let total = price * 2; // можно и в конце строки
Многострочный — через /* */. Комментарием становится всё между ними, хоть на несколько строк:
/*
Здесь можно расписать
что-то длинное на
несколько строк
*/
let x = 5;
Когда какой:
//— для коротких пояснений, это самый частый вариант;/* */— для длинных блоков или чтобы временно «выключить» кусок кода.
Кстати, удобный приём для отладки — закомментировать строку, чтобы она не выполнялась, но и не удалять:
console.log('Это выведется');
// console.log('А это нет — строка отключена');
Совет на будущее: не комментируй очевидное (i++ // увеличиваем i), это шум. Пиши комментарии про «почему так сделано», а не про «что делает строка» — это и так видно из кода. И в большинстве редакторов закомментировать выделенное можно горячими клавишами Ctrl+/ (Cmd+/ на Mac).
Ещё пара мелочей, которые пригодятся:
- многострочные
/* */нельзя вкладывать друг в друга — первый встреченный*/закроет комментарий, и остаток сломается; - для документации функций часто используют JSDoc — это
/** ... */со специальными тегами, по которым редактор показывает подсказки:
/**
* Складывает два числа
* @param {number} a
* @param {number} b
* @returns {number}
*/
function sum(a, b) { return a + b; }
