Использование комментариев в Python

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

Введение

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

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

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

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

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

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

Создание комментария

Чтобы написать комментарий, начните строку с символа #.  Python проигнорирует все, что будет написано после него. Как правило, комментарии выглядят примерно так:

# Это однострочный комментарий

Комментарии также можно размещать в конце строки:

print("https://egorovegor.ru")  # Комментарий в конце строки - это хороший способ объяснить смысл действий в коде

Многострочные комментарии

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

"""
Я многострочная строка, но я также используюсь как
многострочный комментарий.
Python игнорирует все в этом блоке.
"""

# Так тоже можно оформлять
# Многострочные комментарии
# Внутри вашего кода

Если строка не привязана к какой-либо переменной, Python прочитает ее как код, но в итоге проигнорирует.

Пример использования

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

def greet(name):
    greeting = "Привет"
    return name + greeting

test_func = greet('Егор')
# print(test_func)
test_func.upper()  

Заключение

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

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