Словарь › docstring

docstring

Докстринг — это строка-документация прямо внутри функции, класса или модуля: объясняет, что оно делает. Пишется в тройных кавычках сразу после def/class и доступна через help().

def square(n: int) -> int:
    """Возвращает квадрат числа n."""
    return n ** 2

print(square.__doc__)
# Возвращает квадрат числа n.