Комментарии в программе
💻 Информатика · 8 класс
Зачем нужны комментарии
Комментарий — это часть текста программы, которую транслятор полностью игнорирует. Комментарии не выполняются и никак не влияют на работу программы. Их пишут для людей: чтобы пояснить, что делает участок кода, зачем выбрана та или иная формула, какие значения хранят переменные. Хорошо прокомментированную программу легче читать и исправлять — и самому автору спустя время, и любому другому человеку, который будет с ней работать.
На уроках информатики комментарии вводят вместе с первыми программами. Привычку пояснять код полезно вырабатывать сразу: тогда даже сложные программы остаются понятными. Комментарии — это не лишний труд, а способ сделать работу аккуратной и профессиональной.
Виды комментариев
В большинстве языков программирования есть два типа комментариев — однострочные и многострочные. Однострочный действует до конца строки, в которой записан. Многострочный может занимать несколько строк и удобен для больших пояснений.
| Язык | Однострочный | Многострочный |
|---|---|---|
| Паскаль | — | { ... } |
| Питон | # | ''' ... ''' |
| Си-подобные | // | /* ... */ |
Правило. Комментарий объясняет почему сделано так, а не пересказывает очевидное. Строку x = x + 1 не нужно подписывать «прибавляем единицу» — это и так видно из кода.Разобранный пример
Сравните программу без пояснений и с комментариями. Во втором случае сразу понятно, что означает каждая переменная и что вычисляет программа.
# Питон, вычисление площади прямоугольника
a = 5 # длина стороны
b = 3 # ширина
s = a * b # площадь = длина умножить на ширину
print(s) # выводим результат на экранДаже короткие пояснения справа от строк делают программу гораздо понятнее. А если в начале файла добавить комментарий с описанием задачи и именем автора, разобраться в коде станет ещё проще.
Когда комментарии полезны больше всего
- В начале программы — краткое описание задачи и автора.
- Перед сложной формулой или хитрым условием, смысл которого неочевиден.
- Чтобы временно отключить строку кода, не удаляя её совсем.
- Рядом с переменной, назначение которой трудно угадать по имени.
Комментирование как способ отладки
Комментарии помогают и при поиске ошибок. Если временно «закомментировать» подозрительную строку, программа выполнится без неё. Так можно проверить, в этой ли строке кроется ошибка, и при этом не потерять сам код — достаточно потом убрать значок комментария.
Частая ошибка. Слишком много комментариев, повторяющих сам код, мешают чтению не меньше, чем их полное отсутствие. Поясняйте замысел и неочевидные места, а не каждое отдельное действие.
Кратко о главном
- Комментарий — это пояснение в коде, которое транслятор не выполняет.
- Комментарии пишут для людей: они облегчают чтение и правку программы.
- Бывают однострочные и многострочные; запись зависит от языка.
- Комментариями удобно временно отключать строки при отладке.
- Хороший комментарий объясняет замысел, а не пересказывает очевидные действия.