CKTIS / Python
Komentáre a dokumentácia
Znak # mimo reťazcového literálu začína komentár až do konca fyzického riadka.
Verzia: Python 3.14; repository image, production runtime not attested
Syntax
# comment
def label():
"""Describe the result."""
return '#tag'Znak # mimo reťazcového literálu začína komentár až do konca fyzického riadka.
Parser bežné komentáre ignoruje. Úvodný reťazcový literál v tele funkcie môže tvoriť dokumentáciu dostupnú cez __doc__. V textovej časti literálu je # znakom. Od 3.12 môže # vo výraze náhradného poľa f-reťazca začať komentár do konca riadka.
Funkcia vráti #tag a jej dokumentácia znie 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'
Príklady
def label():
"""Return a literal tag."""
# A comment cannot change the returned string.
return "#tag"
print(label(), label.__doc__)
Výsledok
#tag Return a literal tag.
Funkcia vráti #tag a jej dokumentácia znie Return a literal tag.