CKTIS / Python
Commentaar en documentatie
Een # buiten een tekenreeksliteral begint commentaar tot het einde van de fysieke regel.
Versie: Python 3.14; repository image, production runtime not attested
Syntax
# comment
def label():
"""Describe the result."""
return '#tag'Een # buiten een tekenreeksliteral begint commentaar tot het einde van de fysieke regel.
De parser negeert gewoon commentaar. Een tekenreeksliteral vooraan in een functie kan de docstring voor __doc__ leveren. In het letterlijke tekstdeel blijft # een teken. Sinds 3.12 kan # in de expressie van een f-stringveld commentaar tot het regeleinde beginnen.
De functie geeft #tag terug en heeft Return a literal tag. als documentatie.
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'
Voorbeelden
def label():
"""Return a literal tag."""
# A comment cannot change the returned string.
return "#tag"
print(label(), label.__doc__)
Resultaat
#tag Return a literal tag.
De functie geeft #tag terug en heeft Return a literal tag. als documentatie.