Baza znanjaIzpitno središče
SLSlovenščina
Izberi jezik13

CKTIS / Python

Komentarji in dokumentacija

Znak # zunaj besedilnega literala začne komentar do konca fizične vrstice.

Različica: Python 3.14; repository image, production runtime not attested

Sintaksa

# comment

def label():
    """Describe the result."""
    return '#tag'

Znak # zunaj besedilnega literala začne komentar do konca fizične vrstice.

Razčlenjevalnik navadne komentarje prezre. Začetni besedilni literal v telesu funkcije lahko poda dokumentacijo, dosegljivo prek __doc__. V besedilnem delu literala je # znak. Od 3.12 lahko # v izrazu nadomestnega polja f-niza začne komentar do konca vrstice.

Funkcija vrne #tag in njena dokumentacija je Return a literal tag.

import ast
tree=ast.parse('def f():\n    """About f."""\n    # explanation\n    return "#"')
assert ast.get_docstring(tree.body[0])=='About f.'
assert len(tree.body[0].body)==2
assert ast.literal_eval(tree.body[0].body[-1].value)=='#'
text='f"""{1 # comment\n+2}"""'
assert eval(text)=='3'
assert '#tag'=='#'+'tag'

Primeri

def label():
    """Return a literal tag."""
    # A comment cannot change the returned string.
    return "#tag"

print(label(), label.__doc__)

Rezultat

#tag Return a literal tag.

Funkcija vrne #tag in njena dokumentacija je Return a literal tag.

Viri