Python: комментарии, символ # и заметки TODO

Комментарий не выполняется

В Python комментарий начинается с # вне строкового литерала и продолжается до конца физической строки. Его можно поставить перед инструкцией или после неё:

# Позже здесь появится приветствие
print(10)  # Сейчас выводим проверочное число

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

Задание источника

Добавьте заметку о том, что функцию приветствия предстоит написать позже. Полное решение:

# TODO: add a greeting function

Слово TODO не является ключевым словом Python. Это принятое обозначение незавершённой работы внутри обычного комментария. Оно само ничего не запускает и не создаёт функцию.

Несколько строк пояснения

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

Редакционное уточнение: решётка внутри кавычек относится к тексту:

print("Order #1337")  # Решётка в заказе не открывает комментарий

Что проверить

Если требуется только комментарий, вызов print() добавлять не нужно: он изменил бы вывод программы. Комментарий должен описывать причину, ограничение или следующую задачу, а не маскировать случайно оставленный рабочий код. Многострочные строковые литералы и строки документации — отдельные конструкции, не новый вид комментария с решёткой.

Hexlet / Code Basics и участники · Исходный урок и решение · GNU AGPL v3. Адаптация с отмеченным уточнением.