Pythonist

В этой статье мы расскажем о комментариях в Python. Разберемся, зачем они нужны и как их использовать.

Когда нужно использовать комментарии в Python

Давайте разберем два самых общих случая использования комментариев в коде. В принципе, это касается не только Python, но и любого другого языка программирования.

Итак, комментарии нужны, чтобы:

• Предотвратить выполнение кода. Иногда вам нужно сделать так, чтобы часть написанного кода не выполнялась. Возможно, она не нужна вам именно в этот момент, но вы планируете использовать ее в дальнейшем. В таком случае эту часть кода можно «закомментировать», т. е. оформить как комментарий.
• Улучшить читаемость. Это очень важно, и не только для нас самих, но и для других разработчиков. При помощи комментариев мы можем объяснить, что делает каждый блок кода. Когда другие разработчики будут читать наш код, благодаря комментариям им будет легко понять, для чего предназначена каждая его часть.

Как (за)комментировать код на Python

В разных языках программирования синтаксис комментариев тоже разный. В Python комментарии начинаются с символа #. Вот пример:

# Код, расположенный ниже, выводит в консоль фразу Hello World!
print("Hello World!")

В этом коде я использовал комментарий для пояснения, что делает код. Когда этот код выполняется, интерпретатор игнорирует комментарий и запускает функцию print().

Мы также можем закомментировать собственно сам код:

# print("Hello World!")
print("Happy coding!")

При запуске этого кода будет интерпретироваться только вторая строка.

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

print("Hello world") # Выводит Hello World

Как делать многострочные комментарии в Python

В отличие от других языков программирования, в Python нет встроенного синтаксиса для создания многострочных комментариев.

К счастью, есть два способа обойти эту проблему. Первый:

# При запуске этого кода
# вы видите Hello World! 
# в консоли. 
print("Hello world")

Мы можем разделять комментарий на строки, помещая при этом символ # в начале каждой строки.

В следующем примере для размещения комментария мы используем многострочные строки (multi-line strings). Они начинаются и заканчиваются тремя кавычками (сами кавычки могут быть как двойными, так и одинарными).

"""
При запуске этого кода
вы видите Hello World! 
в консоли.
"""
print("Hello World!")

При использовании многострочных строк без присвоения строки в качестве значения переменной эта часть кода игнорируется.

Примечание: важно не забывать об отступах. Если сделаете неправильный отступ перед первым блоком кавычек, получите SyntaxError.

Заключение

Итак, в этой статье мы разобрали, как могут использоваться комментарии в Python, а также рассмотрели их синтаксис. Теперь у вас не должно возникнуть проблем с комментированием кода.

Перевод статьи «Python Comment Block – How to Comment Out Code in Python».