💬 Как комментировать в Python: лучшие советы и примеры

В Python можно комментировать код с помощью символа решетки (#). Комментарий начинается с символа # и продолжается до конца строки. Комментарии игнорируются интерпретатором Python и не выполняются.

# Это комментарий
print("Привет, мир!")  # Этот код выводит "Привет, мир!"

Комментарии важны для повышения читабельности вашего кода и объяснения его функциональности. Они помогают другим программистам понять, что делает определенная часть кода.

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

Комментарии в коде служат для пояснения и объяснения его логики другим разработчикам или себе в будущем. Они не выполняются при исполнении программы и их назначение только информационное.

В Python есть два способа комментирования кода: однострочные комментарии и многострочные комментарии.

Однострочные комментарии

Однострочные комментарии начинаются с символа # и продолжаются до конца строки. Они удобны для добавления кратких пояснений или отключения определенных частей кода.

# Это однострочный комментарий
result = 42  # Вычисление результата
print(result)  # Вывод результата
    

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

Многострочные комментарии позволяют комментировать несколько строк кода сразу. В Python они обрамляются тройными кавычками (одинарными или двойными) в начале и конце комментария.

"""
Это пример
многострочного комментария
"""
result = 42
print(result)
    

Комментарии для документирования кода

Python поддерживает также специальные комментарии для документирования кода, которые называются "docstrings". Они используются для создания документации к модулям, классам, функциям и методам.

def add(a, b):
    """
    Функция сложения двух чисел.
    
    Принимает два аргумента типа int или float
    и возвращает их сумму.
    """
    return a + b
    

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

Заключение

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