Base di conoscenzaCentro esami
ITItaliano
Scegli la lingua13

CKTIS / Python

function.__doc__

Questo attributo contiene la documentazione della funzione o None in assenza di docstring.

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

Sintassi

documentation = function.__doc__

Questo attributo contiene la documentazione della funzione o None in assenza di docstring.

function.__doc__

Un letterale stringa come prima istruzione fornisce la documentazione. Scrivere tramite un alias cambia i metadati dello stesso oggetto senza modificare il corpo.

plain ha None e area(3) continua a dare 9 dopo la modifica.

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

Esempi

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))

Risultato

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

plain ha None e area(3) continua a dare 9 dopo la modifica.

Fonti