CKTIS / Python
Comentários e documentação
Um # fora de um literal de cadeia inicia um comentário até ao fim da linha física.
Versão: Python 3.14; repository image, production runtime not attested
Sintaxe
# comment
def label():
"""Describe the result."""
return '#tag'Um # fora de um literal de cadeia inicia um comentário até ao fim da linha física.
O analisador ignora comentários comuns. Um literal de cadeia inicial no corpo de uma função pode fornecer a documentação acessível por __doc__. No texto literal, # é um dado. Desde 3.12, na expressão de um campo de f-string, # pode iniciar um comentário até ao fim da linha.
A função devolve #tag e a sua documentação é 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'
Exemplos
def label():
"""Return a literal tag."""
# A comment cannot change the returned string.
return "#tag"
print(label(), label.__doc__)
Resultado
#tag Return a literal tag.
A função devolve #tag e a sua documentação é Return a literal tag.