Комментирование кода в Python (Урок №5)

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

Бывает так, что программист написал программу, отложил ее в сторону на несколько дней, а потом с удивлением понимает, что уже и не помнит, что там нагородил =)

На самом деле, это частая ситуация. Я сам регулярно возвращаюсь к своим старым программам и радуюсь (но не всегда), что комментировал собственный код.

И, как результат, я быстрее понимаю, что сам и написал =)

Что такое комментирование кода?

Если кратко, то это поясняющие записи, к тем или иным командам. Можно провести аналогию с заметками на полях книги.

Но прежде чем продолжить далее, отмечу, что можете посмотреть видео (в нем больше информации, по понятным причинам), или прочитать текстовую версию чуть ниже.

Не забудьте подписаться на мой Youtube-канал.

Как комментировать код в Python?

Например, вот так:

b=3  #задаем переменную b
c=5  #задаем переменную c
d=b+c
print(d)  #выводим результат
В Python признаком комментария является символ «решетки» #

При этом, интерпретатор Python игнорирует все символы, которые находятся после # и до конца строки.

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

b=3 #задаем переменную b
c=5 #задаем переменную c
d=b + c
# print(c)
# print(b)
print(d) #выводим результат

Если мы запустим код выше на выполнение, то получим 8 (результат сложения переменных d = b + c).

Но так как две строки

# print(c)

# print(b)

закомментированы, то они не будут исполняться интерпретатором. И мы не увидим на экране, какие значения у переменных b и c.

Это полезная фича, когда тестируется программа, или ищут ошибки в коде.

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

При этом поясняющие комментарии лучше оставить.

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

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

Как сразу закомментировать много строк кода?

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

К счастью, большинство редакторов кода позволяют это сделать быстро.

Например, если используете PyCharm, то достаточно выделить нужный блок кода и нажать сочетание клавиш CTRL + /

Если нужно раскомментировать много строк кода, то опять выделяем нужные строки и снова нажимаем сочетание клавиш CTRL + /.

Уроки по Python 3:

Оставьте комментарий

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