Introducción
Al escribir código Python, siempre es una buena idea hacer el código limpio y fácilmente comprensible. Organizar su código, dar nombres descriptivos a variables y funciones son varias formas de hacer esto.
Otra forma de mejorar la legibilidad de su código es utilizar comentarios. Un comentario es una explicación o anotación legible por humanos que se utiliza para explicar el código. Por ejemplo, si escribió una expresión regular compleja, agregue un comentario que describa lo que hace el código.
Los comentarios también ayudan a otros desarrolladores a comprender su código y su propósito.
Los comentarios deben ser breves y directos. No explique algo que sea obvio para el lector.
Este artículo cubre los conceptos básicos para escribir comentarios en Python.
Escribir comentarios en Python
Python ignora todo lo escrito en la línea después del signo de almohadilla ( # ).
Los comentarios se pueden agregar al principio de la línea o en línea con otros códigos:
# This is a Python comment.
print("Hello World") # This is an inline Python comment.
No se requiere espacio en blanco después de la marca de almohadilla, pero mejorará la legibilidad del comentario.
Un carácter de almohadilla dentro de una cadena literal no indica el comienzo de una línea de comentario. Es simplemente un carácter hash:
paragraph = "# Hash inside quotes is not a comment."Los comentarios deben tener el mismo nivel de sangría que el código siguiente:
def factorial(n):
if n == 0:
return 1
else:
# Use the factorial function
return n * factorial(n-1)Si el editor de texto admite el resaltado de sintaxis, los comentarios generalmente se representan en verde.
Los comentarios también son útiles al depurar un script. En lugar de eliminar algunas líneas o bloques, puede comentarlos:
# for fruit in fruits:
# print(fruit)
Comentarios multilínea en Python (bloques de comentarios)
A diferencia de otros lenguajes de programación comunes, Python solo admite comentarios de una sola línea.
La forma más fácil de escribir comentarios de varias líneas en Python es agregar comentarios de una sola línea uno tras otro:
# This is the first line.
# This is the second line.
Otra opción es utilizar cadenas de documentos.
Las cadenas de documentos son literales de cadenas de varias líneas que se utilizan para documentar lo que hace un módulo, función, clase o método.
Una cadena de documentos comienza y termina con comillas dobles triples ( """ ) y puede abarcar una o más líneas:
"""This is
a multiline
docstring.
"""
Las cadenas de documentos no son técnicamente comentarios. Cuando una cadena de documentos aparece como la primera declaración en un módulo, función, clase o método, termina en el __doc__ de bytes y se convierte en el atributo especial __doc__ de ese objeto. Se recomienda que utilice comentarios hash de una sola línea con regularidad.
El asunto
Si está leyendo scripts de Python, puede notar que en algunos de ellos la primera línea comienza con los caracteres #! y la ruta del intérprete de Python:
#!/usr/bin/env python3
Esta secuencia de caracteres se llama shebang y se utiliza para indicarle al sistema operativo qué intérprete utilizar para analizar el resto del archivo. Los scripts que comienzan con shebang y son ejecutables se pueden ejecutar en la terminal sin escribir python antes del nombre del script.
Dado que la línea shebang comienza con el carácter hash, el intérprete de Python la trata como un comentario y la ignora automáticamente.
Conclusión
Comentar es una buena práctica y ayuda a otros desarrolladores, incluido el yo futuro, a comprender lo que hace el código. En Python, todo lo que sigue al signo de almohadilla ( # ) y hasta el final de la línea se considera un comentario.
