CKTIS / Python
function.__doc__
Este atributo contém a documentação da função ou None se não existir docstring.
Versão: Python 3.14; repository image, production runtime not attested
Sintaxe
documentation = function.__doc__Este atributo contém a documentação da função ou None se não existir docstring.
function.__doc__
Um literal de cadeia como primeira instrução fornece a documentação. Escrever através de um nome alternativo muda os metadados do mesmo objeto sem alterar o corpo.
plain tem None e area(3) continua a dar 9 após a alteração.
def f():
n=1
"Late string."
assert f.__doc__ is None
f.__doc__='text'
assert f.__doc__=='text'
Exemplos
def area(n):
"""Return the area of a square."""
return n*n
def plain(): pass
alias = area
print(area.__doc__, plain.__doc__)
alias.__doc__ = "Area in cm²."
print(area.__doc__, area(3))
Resultado
Return the area of a square. None Area in cm². 9
plain tem None e area(3) continua a dar 9 após a alteração.