KennisbankExamencentrum
NL · NLNederlands (Nederland)
Taal kiezen13

CKTIS / Python

function.__doc__

Dit functieattribuut bevat de docstring of None wanneer die ontbreekt.

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

Syntax

documentation = function.__doc__

Dit functieattribuut bevat de docstring of None wanneer die ontbreekt.

function.__doc__

Een tekenreeksliteral als eerste opdracht levert de documentatie. Schrijven via een alias verandert de metadata van hetzelfde object zonder de functiecode te wijzigen.

plain heeft None en area(3) geeft na wijziging nog steeds 9.

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

Voorbeelden

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

Resultaat

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

plain heeft None en area(3) geeft na wijziging nog steeds 9.

Bronnen