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

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

# Удалить строку ниже после реализации задачи по регистрации
print(10)

В Python все комментарии однострочные. Они начинаются со специального символа #, после которого может идти любой текст. Все, что написано после #, интерпретатор игнорирует.

# комментарий   ──→  [ пропущено интерпретатором ]
print('hello')  ──→  [ выполнено → hello ]
# еще один      ──→  [ пропущено интерпретатором ]

Комментарий может занимать всю строку:

# For Winterfell!
# For Lanisters!

Или стоять в конце строки с кодом:

print('I am the King') # For Lannisters!

Если нужно оставить длинное пояснение, используют несколько строк с #:

# The night is dark and
# full of terrors.
print('I am the King')

Интерпретатор игнорирует комментарии. Разработчики благодаря им быстрее разбираются в чужом коде и не забывают важные детали в собственном.

Служебные комментарии

В процессе работы вы будете встречаться с таким кодом в нашем редакторе:

# BEGIN

# END

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

# BEGIN
<здесь ваше решение>
# END

Увидев BEGIN и END, пишите свой код между ними, остальное оставляйте без изменений.

Задание

Вы пишете программу и понимаете, что одну часть нужно доделать позже. Чтобы не забыть, программисты оставляют себе заметки прямо в коде — TODO-комментарии.

Добавьте в файл такой комментарий:

# TODO: добавить функцию приветствия

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

Полезное

Команда проекта находится в телеграм-сообществе. Там можно задать любой вопрос и повлиять на проект

Нашли ошибку? Есть что добавить? Пулреквесты приветствуются