CKTIS / Python
Komentáře a dokumentace
Znak # mimo řetězcový literál zahajuje komentář až do konce fyzického řádku.
Verze: Python 3.14; repository image, production runtime not attested
Syntaxe
# comment
def label():
"""Describe the result."""
return '#tag'Znak # mimo řetězcový literál zahajuje komentář až do konce fyzického řádku.
Parser běžné komentáře ignoruje. Počáteční řetězcový literál v těle funkce může tvořit dokumentaci dostupnou přes __doc__. V textové části literálu je # znakem. Od 3.12 může # ve výrazu náhradního pole f-řetězce zahájit komentář do konce řádku.
Funkce vrátí #tag a její dokumentace zní 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'
Příklady
def label():
"""Return a literal tag."""
# A comment cannot change the returned string.
return "#tag"
print(label(), label.__doc__)
Výsledek
#tag Return a literal tag.
Funkce vrátí #tag a její dokumentace zní Return a literal tag.