Cómo comentar en Python
Comentar el código es una práctica esencial en la programación, ya que ayuda a documentar el propósito y funcionamiento del código, facilitando su comprensión para otros desarrolladores y para ti mismo en el futuro. Python ofrece maneras simples y efectivas de añadir comentarios, tanto de una sola línea como de varias líneas.
Comentarios de una sola línea
En Python, los comentarios de una sola línea se realizan utilizando el símbolo #. Todo lo que siga a este símbolo en la misma línea es ignorado por el intérprete de Python.
Ejemplo básico:
# Esto es un comentario de una sola línea
print("Hola, mundo!") # Este es otro comentarioEn este ejemplo, el comentario precede a la línea de código, proporcionando una explicación. También es posible añadir comentarios al final de una línea de código, aunque esto debe hacerse con moderación para evitar que la línea se vuelva demasiado larga y difícil de leer.
Comentarios multilínea
Python no tiene un operador específico para comentarios multilínea, pero se pueden crear comentarios que abarquen varias líneas utilizando el símbolo # al comienzo de cada línea. Aunque no es un verdadero comentario multilínea, es la forma recomendada para mantener la coherencia en el código.
Ejemplo:
# Este es un comentario multilínea.
# Puedes escribir tantas líneas como necesites.
# Cada línea debe comenzar con el símbolo '#'.
Alternativamente, se pueden utilizar cadenas de texto multilínea (triple comillas """ o ''') como comentarios. Aunque las cadenas de texto no se utilizan principalmente para comentarios, pueden actuar como tales cuando no se asignan a ninguna variable o no se utilizan de otra forma en el código. Sin embargo, esta práctica no es recomendada para comentarios de bloque, ya que las cadenas de texto en realidad no son ignoradas por el intérprete, sino que son objetos de texto que se mantienen en la memoria.
Ejemplo:
"""
Este es un comentario multilínea usando comillas triples.
No es la práctica recomendada, pero a veces se utiliza
para documentar bloques grandes de código.
"""Comentarios en la documentación (Docstrings)
Los docstrings (o cadenas de documentación) se utilizan para documentar funciones, clases y módulos en Python. Estos comentarios se colocan inmediatamente después de la definición de la función o clase y están delimitados por comillas triples.
Ejemplo:
def saludar(nombre):
"""
Esta función toma un nombre como argumento y
imprime un saludo personalizado.
"""
print(f"Hola, {nombre}!")
Los docstrings son una parte integral de la documentación del código y pueden ser accesibles a través de la función help() en Python, lo que los convierte en una herramienta poderosa para la auto-documentación del código.
Algunas buenas prácticas al comentar
1. Sé claro y conciso: Los comentarios deben ser breves pero informativos. Evita comentarios redundantes o que repitan lo que el código ya expresa claramente.
2. Comenta por qué, no qué: El código ya muestra lo que hace, por lo que los comentarios deben explicar el propósito o la lógica detrás de él, especialmente si es complejo o no obvio.
3. Mantén los comentarios actualizados: Asegúrate de actualizar los comentarios cuando se realicen cambios en el código. Los comentarios obsoletos pueden ser más perjudiciales que no tener comentarios.
4. No abuses de los comentarios: El código debe ser lo suficientemente claro por sí mismo. Usa los comentarios cuando realmente sean necesarios para explicar algo no evidente.
Referencias a sitios oficiales
Para obtener más información sobre comentarios y buenas prácticas de codificación en Python, puedes visitar la documentación oficial de Python.
Jorge García
Fullstack developer