Комментарии

Если вы не хотите разбить свой компьютер, читая собственный код, написанный несколько месяцев назад, тогда используйте комментарии. Комментарии – это строки текста, которые никак не влияют на выполнение программы. Они позволяют документировать код и предназначены исключительно для программистов.

Комментарий в Python начинается с символа #. Всё что идёт дальше и до конца строки – обрабатывается Python как комментарий. Например:


# Это комментарий, занимающий целую строку.
joke = "Фрейд умер, так и не объяснив нам, какие проблемы у тех, кто ставит лайки под собственными постами."
print(joke) # А это комментарий на одной строке с функцией print().

Согласно руководству по стилю PEP 8, комментарий должен быть написан в виде полного предложения. Между # и текстом комментария нужно ставить пробел. Если комментарий находится на одной строке с другой инструкцией, то отступ перед # должен быть два пробела, как в примере выше.

Иногда нужно написать большой комментарий, занимающий несколько строк кода. Это можно сделать так:

# Это очень и очень большой комментарий.
# Он настолько большой, что занимает не одну и не две строки кода.
# А целых три и может занимать ещё больше.
joke = "Фрейд умер, так и не объяснив нам, какие проблемы у тех, кто ставит лайки под собственными постами."
print(joke)

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

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

Упражнение
Создайте комментарий с описанием причины, почему вы хотите изучить Python.