Comentarios - Python para TIC II

En el mundo de la programación, escribir código no es solo hacer que el ordenador entienda lo que quieres que haga, sino también hacer que otras personas (¡o incluso tú mismo en el futuro!) puedan comprender fácilmente tu trabajo. Para esto, utilizamos los comentarios.

¿Qué son los comentarios?¶

¿Para qué sirven los comentarios?¶

Su principal utilidad es proporcionar información adicional. Imagina que escribes una parte compleja de tu programa o una sección con una lógica particular. Con un comentario, puedes explicar el comportamiento de esa sección del programa o recordar el propósito de ciertas variables o funciones. Esto es crucial para la legibilidad del código, que es una piedra angular de la filosofía de diseño de Python. Un código bien comentado es más fácil de leer y entender para todos.

Tipos de comentarios¶

Comentarios de una sola línea (#)
- Estos comentarios comienzan con el símbolo de la almohadilla (#).
- Todo lo que se encuentre desde el # hasta el final de la línea será considerado un comentario y será ignorado por Python.
- Puedes colocarlo en una línea separada para explicar una sección de código, o al final de una línea de código para aclarar lo que hace esa instrucción específica.

# Esto es un comentario de línea única
print("Hola, mundo!")  # Esto es un comentario de línea única

Hola, mundo!

Comentarios de varias líneas ('''...''' o """"...""")

Para comentarios más extensos o para documentar bloques de código, funciones, clases o módulos completos, Python utiliza cadenas de texto encerradas entre tres comillas simples (''') o tres comillas dobles (""").
Cuando se utilizan al principio de un módulo, clase o función, se les conoce como “docstrings” (cadenas de documentación) y son fundamentales para la documentación automática de tu proyecto.

"""
Este es un comentario de varias líneas.
Puedes poner explicaciones largas o notas importantes aquí.
"""
print("Solo este texto se ejecuta")

Solo este texto se ejecuta

Ejercicio 1¶

Añade al menos tres comentarios útiles en este código:

x = 10
y = 5
resultado = x / y
print(resultado)

2.0

Ejercicio 2: Comentarios de bloque¶

Convierte la descripción del siguiente programa en un comentario de varias líneas antes del código:

nombre = "Sara"
edad = 17
print("Hola", nombre)
print("Tu edad es:", edad)

Hola Sara
Tu edad es: 17

Resumen¶

Un buen comentario no solo explica la lógica, sino que hace tu código más profesional. ¡Ponlo en práctica en todos tus proyectos!