CKTIS / Python
Commentaires et documentation
Un # hors d’un littéral de chaîne ouvre un commentaire jusqu’à la fin de la ligne physique.
Version : Python 3.14; repository image, production runtime not attested
Syntaxe
# comment
def label():
"""Describe the result."""
return '#tag'Un # hors d’un littéral de chaîne ouvre un commentaire jusqu’à la fin de la ligne physique.
L’analyseur ignore les commentaires ordinaires. Un littéral de chaîne initial dans une fonction peut fournir la documentation accessible par __doc__. Dans le texte littéral, # est une donnée. Depuis 3.12, dans l’expression d’un champ de f-string, # peut commencer un commentaire jusqu’en fin de ligne.
La fonction renvoie #tag et sa documentation est 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'
Exemples
def label():
"""Return a literal tag."""
# A comment cannot change the returned string.
return "#tag"
print(label(), label.__doc__)
Résultat
#tag Return a literal tag.
La fonction renvoie #tag et sa documentation est Return a literal tag.