Как закомментировать код в js

В JavaScript есть два вида комментариев: однострочные и многострочные. Однострочные выглядят следующим образом:

// однострочный комментарий
const something = 1; // тоже однострочный коммент

Синтаксис многострочных комментариев отличается:

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

В JavaScript два вида комментариев.

Однострочный — от // до конца строки:

// Считаем итоговую цену
const total = price * count; // со скидкой

Многострочный — между /* и */:

/*
const oldTotal = price * count;
console.log(oldTotal);
*/

Интерпретатор пропускает всё, что внутри комментария.

Горячие клавиши

Выделите строки и нажмите:

Повторное нажатие снимает комментарий.

Многострочные комментарии не вкладываются

/*
  /* внутренний */
  этот текст уже код, и здесь будет SyntaxError
*/

Первый */ закрывает внешний комментарий. Чтобы закомментировать кусок, в котором уже есть /* */, используйте // на каждой строке — так делает Ctrl + /.

JSDoc

Комментарий, который начинается с /**, описывает функцию. Редакторы показывают его в подсказках:

/**
 * Возвращает сумму двух чисел.
 * @param {number} a
 * @param {number} b
 * @returns {number}
 */
const sum = (a, b) => a + b;

Комментарии в JSX и HTML

• В JSX внутри разметки: {/* комментарий */}.
• В HTML-файле: <!-- комментарий -->. Внутри тега <script> действуют правила JavaScript.

Что писать в комментариях

Объясняйте, почему код написан именно так: ограничение API, обход бага, бизнес-правило. Что делает код, читатель видит из имён переменных и функций. Закомментированный старый код удаляйте: он остаётся в истории Git.

Синтаксис JavaScript разбирают в бесплатном курсе «Основы JavaScript».