Какие бывают комментарии

КОММЕНТАРИЙ

КОММЕНТАРИЙ (от лат. — толкование) — жанр филологического исследования, представляющий собой разъяснительные примечания к словесно-художественному, публицистическому, литературно-критическому, литературоведческому тексту. В России комментирование началось с первых публикаций памятников древнерусской литературы. Принято различать следующие виды комментариев: текстологический (включает в себя анализ источников текста, его историю, обоснование конъектур), реальный (сообщает о событиях и лицах, упоминаемых в тексте), историко-литературный (прослеживает связи конкретного произведения с различными явлениями литературы), лингвистический (поясняет особенности словоупотребления у того или иного писателя и непонятные слова). Порой комментарий издается как самостоятельное исследование отдельной книгой. Например: Лотман Ю.М. Роман А.С. Пушкина «Евгений Онегин». Комментарий; Бродский Н.Л. «Евгений Онегин». Комментарий к роману А.С. Пушкина; Мануйлов В.А. Роман М.Ю. Лермонтова «Герой нашего времени». Комментарий; Белов СВ. Роман Ф.М. Достоевского «Преступление и наказание». Комментарий; Пустовой П.Г. Роман И.С. Тургенева «Отцы и дети». Комментарий; Фомичев С.А. Комедия А.С. Грибоедова «Горе от ума». Комментарий; Вишневский К.Д. Поэма В.В. Маяковского «Хорошо!». Комментарий; Пинаев М.Г. Роман Н.Г. Чернышевского «Что делать?». Комментарий. В зависимости от назначения и степени освещенности тех или иных вопросов комментарий бывает популярным и научным.

Словарь литературных терминов, 2009-2023.

При создании данного сайта были использованы материалы из книги Игоря Анатольевича Книгина «Словарь литературоведческих терминов»

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');

Такие комментарии, обычно, используют для документирования кода, например, функций.

Задание

Создайте однострочный комментарий с текстом: You know nothing, Jon Snow! .

Упражнение не проходит проверку — что делать? ��

Если вы зашли в тупик, то самое время задать вопрос в «Обсуждениях». Как правильно задать вопрос:

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

В моей среде код работает, а здесь нет ��

Тесты устроены таким образом, что они проверяют решение разными способами и на разных данных. Часто решение работает с одними входными данными, но не работает с другими. Чтобы разобраться с этим моментом, изучите вкладку «Тесты» и внимательно посмотрите на вывод ошибок, в котором есть подсказки.

Мой код отличается от решения учителя ��

Это нормально ��, в программировании одну задачу можно выполнить множеством способов. Если ваш код прошел проверку, то он соответствует условиям задачи.

В редких случаях бывает, что решение подогнано под тесты, но это видно сразу.

Прочитал урок — ничего не понятно ��

Создавать обучающие материалы, понятные для всех без исключения, довольно сложно. Мы очень стараемся, но всегда есть что улучшать. Если вы встретили материал, который вам непонятен, опишите проблему в «Обсуждениях». Идеально, если вы сформулируете непонятные моменты в виде вопросов. Обычно нам нужно несколько дней для внесения правок.

Кстати, вы тоже можете участвовать в улучшении курсов: внизу есть ссылка на исходный код уроков, который можно править прямо из браузера.

Полезное

Определения

Комментарий — текст в коде программы, который не влияет на функциональность и добавляется программистами для себя и своих коллег. // однострочный комментарий

/* многострочный комментарий многострочный комментарий */

Комментарии в Python

Комментарии – способ прокомментировать код на ходу, на той же строке. Вот пример кода. Здесь, “Получил пользователя” – это комментарий.

user = get_user_by_id(...) # Получил пользователя

Такие комментарии начинаются с символа # . Можно добавить комментарий на отдельной строке:

# Получил пользователя user = get_user_by_id(...)

Комментарии ничего не делают, это просто заметки, которые можно оставлять прямо внутри программы.

Иногда программисты комментируют код, чтобы он перестал работать, но при этом не потерять его из виду:

 # Получил пользователя # user = get_user_by_id(. )

Докстринги

Докстринг – строковая переменная, которая идёт сразу за объявлением функции, класса, метода или модуля. Она нужна для документирования всей функции: описания входящих параметров, результата, логики, крайних случаев. Заключается в тройные двойные кавычки. Вот так:

def tensorsolve(a, b, axes=None): """ Solve the tensor equation ``a x = b`` for x. It is assumed that all indices of `x` are summed over in the product, together with the rightmost indices of `a`, as is done in, for example, ``tensordot(a, x, axes=len(b.shape))``. """

В серьёзных проектах из них часто генерируется документация, поэтому они могут быть большими, по несколько экранов. Это касается проектов, у которых есть документация для разработчиков: Django, numpy, sqlalchemy.

Если проект не подразумевает, что им будут пользоваться другие разработчики, такого быть не должно. Длинных докстрингов не должно быть в скрипте ресайза изображений, сайте блога или алгоритме обучения нейронной сети.

Прямо в докстрингах можно писать короткие тесты, их называют доктесты. Ни разу не видел, чтобы кто-то это использовал в боевом проекте.

Как не использовать

Дублировать информацию из кода

Самая частая ошибка, связанная с комментариями: дублирование информации. В таком случае комментарий не несёт дополнительной информации, а просто переводит соседний код с Питона на русский/английский. Пример:

# загружаем данные из файла data.json with open('users.json', 'r') as handler: data = json.load(handler)

Вот как можно исправить:

with open('users.json', 'r') as handler: data = json.load(handler)

А так – ещё лучше:

data = load_all_users_from_file()

Не поддерживать комментарии

Другая частая ошибка: не менять комментарии при изменении кода. В примере выше мы загружали данные из файла. Через месяц взялись за голову и поселили данные в базе данных. Код стал таким:

# загружаем данные из файла data.json data = db_session.query(User).all()

Данные из файла? WAT?

Думать, что все поймут

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

inv(strain_tensor) - rigidity.T # правый случай

Правый, правда? Ну, теперь всё понятно.

Шутить

Шутки к неидеальному коду смотрятся неуместно. Представь, как чувствует себя разработчик, копающийся в чужом коде три часа и находящий новый модуль с заглавным комментарием оставь надежду, всяк сюда входящий . Не будь автором этого комментария. Лучше наведи порядок в своём коде.

Как использовать

Вот хорошие причины использовать комментарии:

объяснить неочевидное поведение: бывает, что нужно объяснить какой-нибудь подводный камень куска кода или объяснить поведение в особом случае; использовать только если ту же информацию в коде поселить нельзя или очень сложно;
оставить напоминание себе или коллеге: речь про комментарии вроде TODO: кешировать ответ ручки или FIXME: учитывать часовой пояс .

Прежде чем написать комментарий, попробуй поселить его в коде, указав параметр или дав подходящее название переменной.

Что изучать

Доклад Григория Петрова про комментирование исходников. Обязателен к просмотру.
PEP 257. ПЕП про докстринги.
doctest. Документация к модулю про доктесты.
What is the best comment in source code you have ever encountered?. Шутить в коде не стоит, а вот посмеяться с чужих шуток можно. Это ж не нам поддерживать.

Попробуйте бесплатные уроки по Python

Получите крутое код-ревью от практикующих программистов с разбором ошибок и рекомендациями, на что обратить внимание — бесплатно.

Переходите на страницу учебных модулей «Девмана» и выбирайте тему.

Какими бывают «комментарии»

Всего найдено 68 выражений для «комментарии». Давайте узнаем, какими бывают «комментарии»:

Слова на букву «к»
Слова c «и» на конце
Слова на «ко»
Слова, оканчивающиеся на «ии»
Слова на «ком»
Слова, оканчивающиеся на «рии»
Слова на «комм»
Слова, оканчивающиеся на «арии»
Составить слова из слова «комментарии»

Только что искали: брамт сейчас мелодия сейчас епрваодея 1 секунда назад апткяр 1 секунда назад клепкасть 1 секунда назад украсть 2 секунды назад зарокмь 2 секунды назад нештаря 2 секунды назад омегабл 3 секунды назад царевна 3 секунды назад епидерсся 3 секунды назад капюшон 3 секунды назад надсмотр 3 секунды назад демонча 4 секунды назад нтлбео 4 секунды назад