Base de conocimientosCentro de exámenes
ESEspañol
Elegir idioma13

CKTIS / Python

Comentarios y documentación

Un # fuera de un literal de cadena inicia un comentario hasta el fin de la línea física.

Versión: Python 3.14; repository image, production runtime not attested

Sintaxis

# comment

def label():
    """Describe the result."""
    return '#tag'

Un # fuera de un literal de cadena inicia un comentario hasta el fin de la línea física.

El analizador ignora los comentarios ordinarios. Un literal de cadena inicial en una función puede proporcionar la documentación accesible por __doc__. En el texto literal, # es un dato. Desde 3.12, en la expresión de un campo de f-string, # puede iniciar un comentario hasta el fin de línea.

La función devuelve #tag y tiene como documentación 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'

Ejemplos

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.

La función devuelve #tag y tiene como documentación Return a literal tag.

Fuentes