WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / Python

Kommentare und Dokumentation

Ein # außerhalb eines Zeichenkettenliterals beginnt einen Kommentar bis zum Ende der physischen Zeile.

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

Syntax

# comment

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

Ein # außerhalb eines Zeichenkettenliterals beginnt einen Kommentar bis zum Ende der physischen Zeile.

Der Parser ignoriert gewöhnliche Kommentare. Ein führendes Zeichenkettenliteral im Funktionsrumpf kann den Docstring für __doc__ liefern. Im Literaltext bleibt # ein Zeichen. Seit 3.12 kann # im Ausdruck eines f-String-Feldes einen Kommentar bis zum Zeilenende beginnen.

Die Funktion liefert #tag und die Dokumentation 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'

Beispiele

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

print(label(), label.__doc__)

Ergebnis

#tag Return a literal tag.

Die Funktion liefert #tag und die Dokumentation Return a literal tag.

Quellen