Znalostní bázeCentrum zkoušek
CSČeština
Vybrat jazyk13

CKTIS / Python

function.__doc__

Tento atribut obsahuje dokumentační řetězec funkce nebo None, pokud chybí.

Verze: Python 3.14; repository image, production runtime not attested

Syntaxe

documentation = function.__doc__

Tento atribut obsahuje dokumentační řetězec funkce nebo None, pokud chybí.

function.__doc__

Řetězcový literál jako první příkaz poskytuje dokumentaci. Zápis přes alias mění metadata téhož objektu bez změny těla funkce.

plain má None a area(3) i po změně popisu vrací 9.

def f():
    n=1
    "Late string."
assert f.__doc__ is None
f.__doc__='text'
assert f.__doc__=='text'

Pří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ýsledek

Return the area of a square. None
Area in cm². 9

plain má None a area(3) i po změně popisu vrací 9.

Zdroje