Как закомментировать код в Python: основы и полезные советы

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

1. Комментарии с использованием символа #:

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

# Это простой комментарий
print("Hello, World!")

Пример работы кода:

Hello, World!

2. Документация функций и модулей:

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

def hello(name: str) -> str:
    """
    Эта функция приветствует пользователя.
    :param name: имя пользователя
    :return: строка с приветствием
    """
    return f"Hello, {name}!"

print(hello("Alice"))

Пример работы кода:

Hello, Alice!

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

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

"""
Это многострочный комментарий.
Здесь можно написать несколько строк текста,
которые не будут выполнены при выполнении программы.
"""

print("Hello, World!") # Эта строка не комментарий

'''
Это еще один многострочный комментарий.
Здесь можно использовать одинарные кавычки вместо двойных.
'''

print("Hello, again!") # Эта строка тоже не комментарий

Пример работы кода:

Hello, World!
Hello, again!

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