Инструкции и комментарии
Чтение — около 5 минут· без учёта практики
Программа состоит из инструкций
В предыдущем уроке
мы вывели несколько сообщений с помощью console.log().
Каждая такая команда — инструкция: запись, которая описывает действие программы.
В наших коротких примерах инструкции выполняются последовательно, сверху вниз.
Сначала будет выведено название магазина, затем сообщение о каталоге:
console.log("Лавка Тони");
console.log("Каталог готов.");Поменяйте инструкции местами
Сначала предскажите порядок сообщений, затем нажмите «Запустить». Переставьте две команды и запустите снова: порядок вывода тоже изменится.
index.html
<html lang="ru">
<head>
<meta charset="utf-8">
<title>Инструкции и комментарии</title>
</head>
<body>
<h1>Проверка сообщений магазина</h1>
<script src="script.js"></script>
</body>
</html>
script.js
console.log("Лавка Тони");
console.log("Каталог готов.");
Нажмите , чтобы запустить пример.
JavaScript не выбирает порядок по смыслу сообщений. Он выполняет записанные действия в том порядке, который вы задали. Позже мы научимся менять ход программы с помощью условий, циклов и функций.
Точка с запятой и перенос строки
В примере каждая инструкция заканчивается точкой с запятой ;.
Перенос строки делает код удобнее для чтения, но несколько инструкций можно записать и в одной строке:
console.log("Лавка Тони"); console.log("Каталог готов.");Результат останется прежним. Для учебных примеров будем записывать одну такую команду на строке и ставить точку с запятой в конце. Это соглашение учебника, которое помогает видеть границы инструкций.
В чужом коде вы встретите и запись без ;:
console.log("Лавка Тони")
console.log("Каталог готов.")
В этом конкретном примере она тоже работает. JavaScript умеет автоматически вставлять точки с запятой
по определённым правилам. Но правило «каждый перенос строки завершает команду» неверно:
следующая строка иногда может продолжать предыдущую. Пока не нужно изучать все такие случаи —
в своих программах придерживайтесь выбранной записи с ;.
Регистр имеет значение
JavaScript различает строчные и прописные буквы. В знакомой команде правильно написано
console.log(), а не Console.log() и не console.Log().
Большая буква меняет имя, которое программа пытается найти.
console.log("Готово.");
Измените в первом редакторе только console на Console и запустите код.
Ожидаемый результат: появится ошибка, а не первое сообщение.
Верните строчную букву — программа снова заработает. Подробно разбирать текст ошибки будем в следующем уроке.
Текст внутри кавычек — другое дело: "Лавка Тони" и "ЛАВКА ТОНИ"
являются двумя разными сообщениями, но оба можно вывести. Написание команды нужно сохранять точным,
а текст сообщения выбираете вы.
Однострочные комментарии
Комментарий — пояснение для человека, читающего исходный код, которое не выполняется как команда.
Два слеша // начинают комментарий, который продолжается до конца строки.
// Сообщаем, какой магазин сейчас проверяем.
console.log("Лавка Тони");
console.log("Каталог готов."); // Следующий этап проверки.
Комментарий можно поставить отдельной строкой или после команды, но в обоих случаях его текст не появится в консоли. Если нужно вывести пояснение посетителю
или разработчику во время выполнения, его надо передать в команду вывода, например console.log().
Многострочные комментарии
Комментарий между /* и */ может занимать несколько строк и заканчивается на первой закрывающей последовательности */:
/*
Проверяем приветствие отдельно от сайта.
Подключение файла уже проверено в браузере.
*/
console.log("Лавка Тони");
Не вкладывайте один такой комментарий в другой. Вложенное начало /* не создаёт
отдельного уровня: первое */ завершит весь комментарий, а оставшийся текст может стать ошибочным кодом.
Если забыть закрыть многострочный комментарий, программа тоже не сможет быть разобрана правильно.
Как временно отключить команду
В процессе работы иногда хочется проверить программу без одной команды, не удаляя её навсегда.
Поставьте // перед этой командой — она станет комментарием.
В следующем примере сообщение о пробной акции не выводится:
Верните команду в программу
Запустите пример: появятся два сообщения. Уберите // перед командой с текстом «Пробная акция» и запустите снова — сообщений станет три.
index.html
<html lang="ru">
<head>
<meta charset="utf-8">
<title>Инструкции и комментарии</title>
</head>
<body>
<h1>Проверка сообщений магазина</h1>
<script src="script.js"></script>
</body>
</html>
script.js
console.log("Лавка Тони");
// console.log("Пробная акция");
console.log("Каталог готов.");
Нажмите , чтобы запустить пример.
Это называют закомментировать код. Чтобы снова включить команду, удалите знаки комментария.
Обратите внимание: в записи console.log("// это текст"); слеши находятся внутри строки,
поэтому выводятся как часть сообщения, а не отключают код.
Коротко
- Инструкции выполняются по порядку, сверху вниз. В учебнике пишем одну инструкцию на строке и ставим
;в конце. - Регистр важен:
console.logиConsole.log— разные имена. Текст внутри кавычек выбираете вы. //начинает комментарий до конца строки,/* … */может занимать несколько строк. Многострочные комментарии не вкладываются друг в друга.- Чтобы временно отключить команду, поставьте перед ней
//. В комментариях полезнее объяснять причины, а не пересказывать очевидный код.
Полный синтаксис и особенности — в справочнике: Выражения и инструкции, Комментарии, Автоматическая вставка точки с запятой.
Проверьте себя
Выберите ответ — объяснение появится сразу. Ответ можно менять.
Задание
Тони дописал в js/shop.js новые сообщения и при этом сломал первую команду.
- Исправьте в ней регистр.
- Сообщение «Черновик акции» временно отключите однострочным комментарием, сохранив команду в исходнике. Над ней добавьте пояснение, что акция ещё не готова к показу.
- В начале файла добавьте многострочный комментарий с описанием цели файла: сообщения Лавки Тони.
Сохраняйте точки с запятой у выполняемых команд.
Ожидаемый результат
- Без ошибок выводятся «Лавка Тони», «Мяч для прогулок», «Есть в наличии» и «Магазин открыт.» в таком порядке.
- Команда с черновиком акции остаётся в коде, но не выполняется.
- Ваши пояснения видны в исходнике, а не в области вывода.
Выполните задание
Условие задания
js/shop.js
Console.log("Лавка Тони");
console.log("Мяч для прогулок");
console.log("Есть в наличии");
console.log("Черновик акции");
console.log("Магазин открыт.");
pages/shop.html
<html lang="ru">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="Лавка Тони — учебный магазин игрушек и вещей для собак.">
<title>Лавка Тони</title>
<link rel="stylesheet" href="../css/style.css">
</head>
<body>
<header>
<nav>
<ul>
<li><a href="../index.html">Главная</a></li>
<li><a href="toys.html">Мои игрушки</a></li>
<li><a href="signup.html">Запись на прогулку</a></li>
<li><a href="shop.html">Лавка Тони</a></li>
</ul>
</nav>
</header>
<main>
<h1>Лавка Тони</h1>
<p>Скоро здесь появятся игрушки и вещи для прогулок. Пока Тони готовит программу магазина.</p>
</main>
<script src="../js/shop.js"></script>
</body>
</html>
Нажмите , чтобы запустить пример.
Подсказка
Начало правильной команды — console.log. Для отключения одной строки добавьте // перед командой, а не внутрь её кавычек. Многострочное пояснение ограничьте знаками /* и */.
Продолжите в VS Code
Внесите те же изменения в js/shop.js своего сайта my-site, сохраните файл, откройте pages/shop.html в браузере и обновите страницу. Проверка: в консоли та же последовательность сообщений, что и в редакторе. Если результат отличается, нажмите в редакторе «Показать решение» и сравните со своим кодом.