JavaScript: Комментарии
Кроме кода, в файлах с исходным кодом могут находиться комментарии. Это текст, который не является частью программы и нужен программистам для пометок. С их помощью добавляют пояснения, как работает код, какие здесь ошибки нужно поправить или не забыть что-то добавить позже.
// Удалить строку ниже после реализации задачи по регистрации
console.log(10);
Комментарии в JavaScript бывают двух видов:
Однострочные комментарии
Однострочные комментарии начинаются с //
. После этих двух символов может следовать любой текст, вся строчка не будет анализироваться и исполняться.
Комментарий может занимать всю строчку. Если одной строчки мало, то создаются несколько комментариев:
// For Winterfell!
// For Lanisters!
Комментарий может находиться на строчке после какого-нибудь кода:
console.log('I am the King'); // For Lannisters!
Многострочные комментарии
Многострочные комментарии начинаются с /*
и заканчиваются на */
.
/*
The night is dark and
full of terrors.
*/
console.log('I am the King');
https://replit.com/@hexlet/helloworld
Такие комментарии, обычно, используют для документирования кода, например, функций.
Задание
Создайте однострочный комментарий с текстом: You know nothing, Jon Snow!
.
Упражнение не проходит проверку — что делать? 😶
Если вы зашли в тупик, то самое время задать вопрос в «Обсуждениях». Как правильно задать вопрос:
- Обязательно приложите вывод тестов, без него практически невозможно понять что не так, даже если вы покажете свой код. Программисты плохо исполняют код в голове, но по полученной ошибке почти всегда понятно, куда смотреть.
В моей среде код работает, а здесь нет 🤨
Тесты устроены таким образом, что они проверяют решение разными способами и на разных данных. Часто решение работает с одними входными данными, но не работает с другими. Чтобы разобраться с этим моментом, изучите вкладку «Тесты» и внимательно посмотрите на вывод ошибок, в котором есть подсказки.
Мой код отличается от решения учителя 🤔
Это нормально 🙆, в программировании одну задачу можно выполнить множеством способов. Если ваш код прошел проверку, то он соответствует условиям задачи.
В редких случаях бывает, что решение подогнано под тесты, но это видно сразу.
Прочитал урок — ничего не понятно 🙄
Создавать обучающие материалы, понятные для всех без исключения, довольно сложно. Мы очень стараемся, но всегда есть что улучшать. Если вы встретили материал, который вам непонятен, опишите проблему в «Обсуждениях». Идеально, если вы сформулируете непонятные моменты в виде вопросов. Обычно нам нужно несколько дней для внесения правок.
Кстати, вы тоже можете участвовать в улучшении курсов: внизу есть ссылка на исходный код уроков, который можно править прямо из браузера.
Полезное
Определения
Комментарий — текст в коде программы, который не влияет на функциональность и добавляется программистами для себя и своих коллег.
// однострочный комментарий
/* многострочный комментарий многострочный комментарий */