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');Такие комментарии, обычно, используют для документирования кода, например, функций.
Служебные комментарии
В процессе работы вы будете встречаться с таким кодом в нашем редакторе:
// BEGIN
// ENDBEGIN и END здесь — это обычные комментарии, которые никак не влияют на работу программы. Они показывают, куда писать код задания.
// BEGIN
<здесь ваше решение>
// ENDУвидев BEGIN и END, пишите свой код между ними, остальное оставляйте без изменений.
Задание
Вы пишете программу и понимаете, что одну часть нужно доделать позже. Чтобы не забыть, программисты оставляют себе заметки прямо в коде — TODO-комментарии.
Добавьте в файл такой комментарий:
// TODO: add a greeting functionКогда вернётесь к этому месту позже, комментарий напомнит, что здесь ещё есть незавершённая работа.
Полезное
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');Такие комментарии, обычно, используют для документирования кода, например, функций.
Служебные комментарии
В процессе работы вы будете встречаться с таким кодом в нашем редакторе:
// BEGIN
// ENDBEGIN и END здесь — это обычные комментарии, которые никак не влияют на работу программы. Они показывают, куда писать код задания.
// BEGIN
<здесь ваше решение>
// ENDУвидев BEGIN и END, пишите свой код между ними, остальное оставляйте без изменений.
Задание
Вы пишете программу и понимаете, что одну часть нужно доделать позже. Чтобы не забыть, программисты оставляют себе заметки прямо в коде — TODO-комментарии.
Добавьте в файл такой комментарий:
// TODO: add a greeting functionКогда вернётесь к этому месту позже, комментарий напомнит, что здесь ещё есть незавершённая работа.
Полезное
Ваше упражнение проверяется по этим тестам
// @ts-nocheck -- tsconfig has no Node.js types (types: []), and the test reads the source via node:fs
import { readFileSync } from 'node:fs';
import { fileURLToPath } from 'node:url';
import { expect, test } from 'vitest';
test('comments', () => {
const code = readFileSync(
fileURLToPath(new URL('./index.js', import.meta.url)),
'utf-8',
);
// The code must contain at least one single-line TODO comment
expect(code).toMatch(/\/\/\s*TODO/i);
});Решение учителя откроется через:
20:00
