Описание тега docstring

Строка документации - это строка, которая встречается в качестве первого оператора в определении модуля, функции, класса или метода и используется для документирования объекта, в котором она встречается.

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

Например, этот модуль Python:

"""shibboleth.py - answer a common interview question with style and grace."""

DEFAULTS = (
    (3, "Fizz"),
    (5, "Buzz"),
)


def fizzbuzz(limit=15, sep=" ", **kwargs):
    """Print from 1 to `limit`, replacing as in the childhood game."""
    transform = sorted((v, k) for k, v in kwargs.items()) or DEFAULTS
    for number in range(1, limit + 1):
        matches = (word for factor, word in transform if number % factor == 0)
        print(sep.join(matches) or number)

... содержит две строки документации: строку документации уровня модуля, которая содержит имя файла модуля и краткое описание его назначения, и строку документации уровня функции, которая описывает поведение функции, в которой она встречается.

Соглашения о написании строк документации Python можно найти в PEP 257: Docstring Conventions.

Информацию о строках документации на других языках, кроме Python, можно найти в Википедии.