Python · Essencial · Inglês · Técnico
docstring
Texto entre aspas triplas logo abaixo do def, do class ou no início do módulo, que documenta o objeto. Fica acessível em __doc__ e na função help().
Onde usar
Editores, help() e geradores de documentação mostram a docstring. Num review, funções públicas sem docstring costumam ser apontadas.
Em código
def dobro(n):
"""Devolve o dobro de n."""
return n * 2
print(dobro.__doc__)Exemplos
Add a docstring explaining the parameters.
Adicione uma docstring explicando os parâmetros.
The help function shows whatever is in the docstring.
A função help mostra o que estiver na docstring.
Cuidado
Não é um comentário: a docstring é um valor guardado no objeto, e só a primeira string do corpo conta.
Sinônimos
documentation string
Origem
Contração de documentation string.