CKTIS / Python
function.__doc__
Ta atribut vsebuje dokumentacijski niz funkcije ali None, če niz manjka.
Različica: Python 3.14; repository image, production runtime not attested
Sintaksa
documentation = function.__doc__Ta atribut vsebuje dokumentacijski niz funkcije ali None, če niz manjka.
function.__doc__
Besedilni literal kot prvi ukaz poda dokumentacijo. Pisanje prek drugega imena spremeni metapodatke istega objekta brez spremembe telesa funkcije.
plain ima None in area(3) po spremembi še vedno vrne 9.
def f():
n=1
"Late string."
assert f.__doc__ is None
f.__doc__='text'
assert f.__doc__=='text'
Primeri
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))
Rezultat
Return the area of a square. None Area in cm². 9
plain ima None in area(3) po spremembi še vedno vrne 9.