docstring — это строковый литерал, который появляется как первое выражение в теле модуля, функции, класса или метода. Его назначение — предоставить встроенную документацию для этого блока кода.
Docstring'и пишутся с использованием тройных кавычек, что позволяет им занимать несколько строк:
def greet(name):
"""Return a greeting message for the given name."""
return f"Hello, {name}!"
Более подробный пример с несколькими строками:
def greet(name):
"""
Return a greeting message.
Args:
name (str): The name of the person to greet.
Returns:
str: A formatted greeting string.
"""
return f"Hello, {name}!"
Есть два стандартных способа получить доступ к docstring'у во время выполнения:
.__doc__ напрямую на объектеhelp() для форматированного выводаprint(greet.__doc__)
help(greet)
.__doc__ объектаDocstring должен быть размещен как первый оператор внутри модуля, функции, класса или определения метода, чтобы правильно распознаваться и сохраняться как атрибут .__doc__.
Новый — ещё не проверен сообществом
Вы