База знанияИзпитен център
BGБългарски
Избери език13

CKTIS / Python

function.__doc__

Този атрибут съдържа документационния низ на функцията или None при липсата му.

Версия: Python 3.14; repository image, production runtime not attested

Синтаксис

documentation = function.__doc__

Този атрибут съдържа документационния низ на функцията или None при липсата му.

function.__doc__

Низов литерал като първа инструкция дава документацията. Записването чрез друго име променя метаданните на същия обект без промяна на тялото.

plain има None, а area(3) след промяната продължава да връща 9.

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

Примери

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

Резултат

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

plain има None, а area(3) след промяната продължава да връща 9.

Източници