Sentencias, indentación y comentarios en Python: Guía clara

Sentencias, indentación y comentarios en Python

Esta guía explica las sentencias de Python, la importancia de la indentación consistente y cómo usar comentarios y docstrings efectivamente.

Sentencias en Python

Las instrucciones de Python que el intérprete ejecuta se llaman sentencias. Ejemplos comunes incluyen sentencias de asignación como a = 1, sentencias de control de flujo como if, for y while. Estos fundamentos forman los bloques de construcción de todo programa Python.

Sentencias multilínea

Por defecto, un salto de línea termina una sentencia. Para dividir una sentencia larga en varias líneas, puede usar el carácter de continuación de línea barra invertida (\):

a = 1 + 2 + 3 + \
4 + 5 + 6 + \
7 + 8 + 9

Más idiomáticamente, Python permite continuación implícita dentro de paréntesis, corchetes o llaves:

a = (1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9)

De manera similar, los literales de lista pueden abarcar múltiples líneas:

colores = ['rojo', 'azul', 'verde']

También puede colocar varias sentencias simples en una línea usando punto y coma:

a = 1; b = 2; c = 3

---

Indentación en Python

A diferencia de lenguajes que dependen de llaves, Python define bloques de código puramente mediante indentación. Un bloque comienza después de dos puntos y termina en la primera línea que no está indentada respecto al inicio del bloque.

Aunque el lenguaje permite cualquier nivel de indentación consistente, el estándar de la comunidad son cuatro espacios. Las tabulaciones deben evitarse para prevenir confusión.

for i in range(1, 11):
    print(i)
    if i == 5:
        break

La indentación correcta no solo impone sintaxis sino que también hace el código inmediatamente legible y mantenible. Por ejemplo:

if True:
    print('Hola')
    a = 5

versus la forma menos legible en una línea:

if True: print('Hola'); a = 5

La indentación incorrecta dispara un IndentationError y detiene la ejecución.

---

Comentarios en Python

Los comentarios son vitales para documentar intención y lógica, especialmente al revisar código meses después. En Python, un comentario comienza con almohadilla (#) y se extiende hasta el final de la línea. El intérprete ignora estas líneas completamente.

# Esto es un comentario
# Imprimir saludo
print('Hola')

---

Comentarios multilínea

Para abarcar varias líneas, puede prefijar cada línea con #:

# Este es un comentario largo
# que continúa sobre varias
# líneas

Alternativamente, strings entre comillas triples pueden servir como comentarios de bloque. Cuando no se asignan ni usan como docstring, son descartados por el intérprete, sin costo en tiempo de ejecución:

"""Este es un comentario multi-línea
que abarca varias líneas."""

---

Docstrings en Python

Un docstring es un literal de string que sigue a una definición de función, clase o módulo. Documenta el propósito del elemento y se almacena en su atributo __doc__. Se usan comillas triples convencionalmente:

def doble(num):
    """Devuelve el doble del valor de entrada."""
    return 2 * num

Puede acceder a él programáticamente:

print(doble.__doc__)

Salida:

Devuelve el doble del valor de entrada.

Para directrices más detalladas, consulte la documentación oficial de Python sobre comentarios y docstrings.