Что такое docstring

Docstring (строка документации) — это строка, расположенная в начале модуля, функции, класса или метода, которая описывает его назначение и использование. Она доступна через атрибут __doc__ и используется для генерации документации (например, с помощью help() или Sphinx).

Пример:

def add(a, b):
    """
    Возвращает сумму двух чисел.

    Args:
        a (int): Первое число.
        b (int): Второе число.

    Returns:
        int: Сумма a и b.
    """
    return a + b

print(add.__doc__)  # Выведет docstring
help(add)           # Покажет документацию

Особенности:

• Заключается в тройные кавычки (""" или ''').
• Может быть многострочной.
• Часто следует стандартам (Google, NumPy, reST).