Introducción a los comentarios y la legibilidad del código

Los comentarios se usan para explicar el código y hacerlo más legible. El intérprete de Python los ignora y no afectan a la ejecución del programa.

En esta lección, aprenderá a usar comentarios y a escribir código limpio y legible.

Comentarios de una línea

Los comentarios de una línea comienzan con un #. Python ignora todo lo que aparece después de # en esa línea. Por ejemplo:

# This is a single-line comment
print("Hello, World!")

Comentarios de varias líneas

Los comentarios de varias líneas se pueden escribir mediante comillas triples (''' o """). Por ejemplo:

"""
This is a multi-line comment.
It spans multiple lines.
"""
print("Hello, World!")

¿Por qué utilizar comentarios?

Los comentarios son útiles para:

• Explicar código complejo.
• Facilitar la comprensión del código a otras personas y a usted mismo en el futuro.
• Depurar y solucionar problemas.

Recuerde: los comentarios son para las personas, no para la máquina.

Buenas prácticas para escribir comentarios

Estos son algunos consejos para escribir buenos comentarios:

• Procure que los comentarios sean concisos y significativos.
• Evite comentarios obvios como # Increment x by 1 para x = x + 1.
• Use comentarios para explicar por qué el código está escrito de una determinada manera.

Mejora de la legibilidad del código

El código legible es más fácil de mantener y depurar. Estos son algunos consejos:

• Utilice nombres descriptivos para las variables y las funciones.
• Mantenga cortas las líneas de código.
• Organice el código en secciones mediante comentarios.

Comentar código

Puede utilizar comentarios para deshabilitar temporalmente código con fines de depuración. Por ejemplo:

# print("This line is commented out and won’t run.")
print("This line will run.")

Ejemplo: documentar una función

Puede utilizar comentarios para documentar funciones y explicar su propósito:

def greet(name):
    # This function greets the user by their name.
    print("Hello,", name)

greet("Alice")

¿Qué hemos aprendido?

En esta lección, ha aprendido:

• Cómo escribir comentarios de una sola línea y de varias líneas en Python.
• La importancia de los comentarios para la legibilidad y el mantenimiento del código.
• Prácticas recomendadas para escribir comentarios y mejorar la legibilidad del código.

¡Muy bien! Pasemos al siguiente tema.