CKTIS / Python
Komentarze i dokumentacja
Komentarz zaczyna się od # poza literałem tekstowym i trwa do końca fizycznego wiersza.
Wersja: Python 3.14; repository image, production runtime not attested
Składnia
# comment
def label():
"""Describe the result."""
return '#tag'Komentarz zaczyna się od # poza literałem tekstowym i trwa do końca fizycznego wiersza.
Parser pomija zwykły komentarz. Pierwszy literał tekstowy w ciele funkcji może być dokumentacją dostępną przez __doc__. W części tekstowej literału # jest danymi. Od 3.12 wewnątrz pola wyrażenia f-string # rozpoczyna komentarz do końca wiersza.
Funkcja zwraca #tag, a jej dokumentacja ma wartość 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'
Przykłady
def label():
"""Return a literal tag."""
# A comment cannot change the returned string.
return "#tag"
print(label(), label.__doc__)
Wynik
#tag Return a literal tag.
Funkcja zwraca #tag, a jej dokumentacja ma wartość Return a literal tag.