目次
1. Conceptos básicos de comentar en Python y su importancia
Comentar en Python es una herramienta importante para que el código sea fácil de entender cuando otros o tú mismo lo revisen más adelante. Al dejar explicaciones o notas del código, se mejora la mantenibilidad del programa y se facilita identificar las causas de errores y explicar la lógica. Además, también resulta útil para desactivar temporalmente código durante el desarrollo y realizar pruebas.1.1 Fundamentos de los comentarios de una sola línea
En Python, los comentarios de una sola línea usan «#». Al colocar «#» al inicio de la línea, toda esa línea se trata como un comentario.# Esto es un comentario
print("Hello, World!") # Esta parte también se considera un comentario
De este modo, puedes añadir comentarios que expliquen el código y que sean útiles en futuras modificaciones.
1.2 Descripción general de los comentarios de varias líneas
Para comentarios de varias líneas, lo más común es añadir «#» a cada línea por separado. Esto requiere insertar «#» manualmente en cada línea, pero es muy eficaz cuando se desea desactivar bloques de código largos.# Esta es la primera línea de comentario
# Esta es la segunda línea de comentario
# Esta es la tercera línea de comentario
También existen algunos métodos eficientes para ahorrar trabajo con los comentarios de varias líneas, que se explicarán más adelante.
2. Dos formas de comentar varias líneas en Python
Existen varias técnicas útiles para comentar varias líneas. A continuación se presentan dos métodos representativos.2.1 Comentar varias líneas con «#»
Comentar varias líneas con «#» es el método más simple y habitual.# Este es el comentario de la línea 1
# Este es el comentario de la línea 2
# Este es el comentario de la línea 3
Sin embargo, cuando hay muchas líneas resulta laborioso, por lo que este método es adecuado para bloques relativamente pequeños.2.2 Comentar varias líneas con comillas triples
En Python, al usar tres comillas simples (»’) o tres comillas dobles («»») de forma consecutiva, es posible comentar varias líneas. Esto se utiliza originalmente como cadena de documentación (docstring), pero también se emplea como alternativa para comentar."""
Aquí hay un comentario de varias líneas
Se pueden desactivar varias líneas
"""
Sin embargo, este método se reconoce como una cadena, por lo que estrictamente no es un comentario. Puede hacer que el código consuma recursos innecesarios, por lo que se debe tener cuidado, especialmente en proyectos de gran tamaño o cuando el uso de memoria es importante.</final3. Errores comunes al comentar en Python y cómo evitarlos
Hay varios aspectos a tener en cuenta al comentar código. En particular, es necesario ser cauteloso con los errores de indentación y con el uso de las comillas triples.3.1 Evitar errores de indentación
Python impone reglas estrictas de indentación; si el código no está indentado correctamente, se produce un IndentationError. Incluso al comentar con comillas triples, si la indentación se desajusta puede provocar errores inesperados.def example():
"""
Esto es un comentario
"""
print("Hello, World!") # Esto provocará un error de indentación
En Python es muy importante mantener la indentación consistente.