Урок 2. Комментарии JavaScript

Все уроки по JavaScript расположены здесь.

Программирование часто является коллективным занятием. Кроме того, наш собственный код может быстро стать трудным для понимания, когда мы вернемся к нему — иногда уже через час! По этим причинам часто бывает полезно оставлять заметки в нашем коде другим разработчикам или самим себе.

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

Комментарии могут объяснить, что делает код, оставить инструкции для разработчиков, использующих код, или добавить любые другие полезные аннотации.

В JavaScript существует два типа комментариев кода. Однострочный комментарий закомментирует одну строку и обозначается двумя косыми чертами // перед ней.

// Вывод 5 на консоль
console.log(5);

Можно также использовать однострочный комментарий для комментария после строки кода:

console.log(5); // Печать 5

Многострочный комментарий закомментирует несколько строк и обозначается символами /*, чтобы начать комментарий, и */, чтобы закончить комментарий.

/*
Это все закомментировано
console.log(10); 
Ничего из этого не будет выведено в консоль!
console.log(99);
*/

Вы также можете использовать этот синтаксис для комментирования чего-либо в середине строки кода:

console.log(/*игнорируется!*/ 5); // все еще печатает 5

Задачи к уроку

Давайте попрактикуемся в добавлении комментариев к коду.

console.log('Одно из немногих все искупляющих качеств наставников, думаю я, заключается в том, что их при случае можно одурачить.');
console.log('Это было верно, когда мать учила меня читать, это было верно,');
console.log('когда отец пытался научить меня быть фермером, и верно теперь, когда я обучаюсь магии.');
console.log('– Ты не практиковался! – прервал мои размышления резкий упрек Гаркина.');
console.log('– А вот и нет! – возразил я. – Это просто трудное упражнение.');
console.log('Словно в ответ левитируемое мною перо начало дрожать и колебаться в воздухе.');

1. В строке 1 кода выше напишите однострочный комментарий, в котором будет название книги, из которой эти строки.


2. Один комментарии для добавления контекста в коде. Многострочные комментарии часто лучше всего подходят для предотвращения выполнения блока кода. Однако оба типа комментариев могут использоваться для обеих целей. Используйте многострочный комментарий так, чтобы ничего не выводилось в строках 3-5.

Предыдущий: Урок 1. Консоль JavaScript | Урок 3. Типы данных JavaScript