Opción 2: Usar cadenas multilínea como comentarios
otra opción para escribir comentarios multilínea «adecuados» en Python es usar cadenas multilínea con la sintaxis """ de manera creativa. Este es un ejemplo:
"""This is a "block comment" in Python, madeout of a mult-line string constant.This actually works quite well!"""answer = 42
como puede ver, puede usar cadenas de Comillas triples para crear algo que se asemeje a un comentario multilínea en Python., Solo necesita asegurarse de sangrar el primer """ correctamente, de lo contrario obtendrá un SyntaxError. Por ejemplo, si desea definir un comentario de bloque dentro de una función con esta técnica, debe hacerlo de la siguiente manera:
solo tenga en cuenta que esta técnica no crea comentarios «verdaderos». Esto simplemente inserta una constante de texto que no hace nada. Es lo mismo que insertar una cadena de una sola línea regular en algún lugar de su código y nunca acceder a ella.,
sin embargo, tal constante de cadena huérfana no se mostrará en el bytecode, convirtiéndolo efectivamente en un comentario multilínea. Aquí hay una prueba de que la cadena no utilizada no aparecerá en el desmontaje del código de bytes de CPython:
Sin embargo, tenga cuidado donde coloca estos «comentarios» en el código., Si la cadena sigue inmediatamente después de una firma de función, una definición de clase o al comienzo de un módulo, se convierte en una cadena de documentos que tiene un significado completamente diferente en Python:
Docstrings («cadenas de documentación») le permiten asociar documentación legible por humanos con módulos, funciones, clases y métodos de Python. Son diferentes de los comentarios del código fuente:
un comentario es eliminado por el analizador, mientras que un docstring termina en el bytecode y está asociado con el objeto documentado. Incluso se puede acceder mediante programación en tiempo de ejecución.,
como dije anteriormente, la única manera de obtener comentarios multilínea «verdaderos» en Python que son ignorados por el analizador es usar múltiples # comentarios de una sola línea.
admito que me sorprendió un poco encontrar este estilo de comentario de bloque «falso» respaldado por Guido van Rossum, el creador de Python: