← Все вопросы

Что такое docstring и как его правильно писать?

Задан 12 месяцев назад701 просмотров3 ответа
13

Видел, что сразу после def некоторые пишут строку в тройных кавычках с описанием. Это и есть docstring? Чем он отличается от обычного комментария и зачем нужен?

3 ответа

21
✓ Принятый ответ — помог автору

Да, docstring — это строковый литерал сразу первой строкой в теле функции (класса, модуля), обычно в тройных кавычках. Он описывает, что делает функция.

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

Чем отличается от комментария #:

  • docstring сохраняется в самом объекте и доступен в рантайме через summa.__doc__ и help(summa);
  • обычный комментарий # отбрасывается интерпретатором и нигде не доступен.

Поэтому docstring видят IDE, help() и инструменты документации. Для длинных функций принято описывать параметры и что возвращается (стили Google/NumPy/reStructuredText).

8

Строка в тройных кавычках первой строкой в функции. Доступна через help(func) и func.__doc__, в отличие от обычного #-комментария.

4

Документация функции, видна в help().

Ваш ответ

Войдите, чтобы ответить на вопрос.
Поддержать проект