CKTIS / Python
function.__doc__
Tento atribút obsahuje dokumentačný reťazec funkcie alebo None, ak chýba.
Verzia: Python 3.14; repository image, production runtime not attested
Syntax
documentation = function.__doc__Tento atribút obsahuje dokumentačný reťazec funkcie alebo None, ak chýba.
function.__doc__
Reťazcový literál ako prvý príkaz poskytne dokumentáciu. Zápis cez alias mení metadáta toho istého objektu bez zmeny tela funkcie.
plain má None a area(3) aj po zmene opisu vracia 9.
def f():
n=1
"Late string."
assert f.__doc__ is None
f.__doc__='text'
assert f.__doc__=='text'
Príklady
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))
Výsledok
Return the area of a square. None Area in cm². 9
plain má None a area(3) aj po zmene opisu vracia 9.