Cómo comentar varias líneas en Python: métodos, atajos y buenas prácticas

1. Introducción

Python es un lenguaje de programación utilizado por una amplia gama de desarrolladores, desde principiantes hasta expertos, gracias a su facilidad para gestionar el código. Sin embargo, para desactivar temporalmente una parte del programa o dejar explicaciones a otros desarrolladores, el comentado es fundamental. En particular, los comentarios en varias líneas son una técnica imprescindible para depurar y facilitar la comprensión del código. En este artículo explicaremos los distintos métodos para comentar varias líneas en Python. Veremos el método básico usando #, el uso de comillas triples, y también los atajos de teclado disponibles en algunos entornos de desarrollo para comentar de manera más eficiente. Todo acompañado de ejemplos de código claros, fáciles de entender incluso para principiantes.

2. Método básico de comentarios en Python

La forma más común de hacer comentarios en Python es utilizando el símbolo #. Todo lo que aparezca después de este símbolo en la misma línea será ignorado al momento de ejecutar el programa. Este método es sencillo y muy útil para agregar explicaciones al código o desactivar líneas temporalmente.

2.1 Comentarios de una sola línea

Al escribir # al inicio de una línea, esa instrucción quedará desactivada como comentario.
# Esto es un comentario de una línea
print("Hola, Mundo!")  # También se pueden añadir comentarios al final de una línea
El comentario por línea permite añadir notas en cualquier parte del código, facilitando su comprensión.

2.2 Comentarios en varias líneas

Si deseas desactivar varias líneas de código, debes añadir # al inicio de cada una. Esto es especialmente útil durante la depuración.
# Este código no se ejecutará
# Comentarios en varias líneas
print("Esta línea está desactivada")
 
RUNTEQ(ランテック)|超実戦型エンジニア育成スクール

3. Métodos para comentar varias líneas

En Python, además del símbolo #, existen otras formas de comentar varias líneas de manera eficiente, como el uso de atajos de teclado o de comillas triples.

3.1 Uso de atajos para comentar con #

La mayoría de los entornos de desarrollo permiten seleccionar varias líneas y añadir # de forma automática con un atajo. Por ejemplo, en Visual Studio Code se puede usar Ctrl + / para comentar o descomentar varias líneas a la vez.
# Ejemplo: comentar varias líneas seleccionadas
# a = 1
# b = 2
# c = a + b
De esta forma, puedes ahorrar tiempo al comentar bloques de código.

3.2 Uso de comillas triples

En Python también puedes utilizar comillas triples (''' o """) para encerrar bloques de texto que funcionen como comentarios. Aunque en realidad se tratan de literales de cadena, al no asignarse a ninguna variable son ignorados por el programa. Normalmente se utilizan como docstrings, pero también sirven como alternativa para comentar varias líneas.
'''
Este bloque quedará comentado.
Es útil cuando quieres desactivar varias líneas.
'''
print("Esto sí se ejecutará")
Es importante tener en cuenta que al ser tratados como cadenas, conviene usarlos con moderación para no consumir memoria innecesariamente.

4. Ejemplos y consideraciones al usar comillas triples

Cuando utilizas comillas triples para comentar, hay ciertos puntos a tener en cuenta. En particular, la indentación es crucial: si no está alineada correctamente, se puede producir un error.

4.1 Ejemplo correcto

Para usar comillas triples de forma correcta, asegúrate de que la indentación esté alineada. Aquí un ejemplo válido:
def sample():
    '''
    Este bloque será tratado como comentario.
    La indentación es consistente.
    '''
    print("Esta parte sí se ejecutará")

4.2 Ejemplo con error

Si la indentación no está bien alineada, se producirá un IndentationError:
def sample():
'''
Este comentario producirá un error
La indentación no es correcta
'''
    print("Aquí ocurrirá un error")
Por lo tanto, es fundamental cuidar la indentación al usar comillas triples.
侍エンジニア塾

5. Atajos de comentarios en entornos de desarrollo Python

Los principales entornos de desarrollo incluyen atajos para comentar varias líneas de código rápidamente. Veamos cómo funciona en PyCharm, Visual Studio Code y Jupyter Notebook.

5.1 PyCharm

En PyCharm, puedes usar Ctrl + / para comentar tanto una sola línea como varias líneas de manera sencilla.

5.2 Visual Studio Code

En Visual Studio Code también puedes usar Ctrl + / para comentar, pero si deseas aplicar un bloque de comentario, puedes usar Shift + Alt + A.

5.3 Jupyter Notebook

En Jupyter Notebook, el atajo Ctrl + / permite comentar múltiples líneas a la vez, lo cual resulta muy útil para científicos de datos e ingenieros que trabajan con notebooks.

6. Mejores prácticas al comentar

Los comentarios son esenciales para clarificar el propósito del código y facilitar su mantenimiento. Sin embargo, un exceso de comentarios puede tener el efecto contrario. Veamos cómo usarlos de manera efectiva.

6.1 Inserción adecuada de comentarios

Los comentarios deben explicar la intención del código, no describir línea por línea lo que ya es evidente. Ejemplo:
# Recibe dos parámetros a y b, y devuelve su suma
def add(a, b):
    return a + b

6.2 Evitar comentarios excesivos

Un exceso de comentarios hace que el código sea más difícil de leer. Este es un ejemplo a evitar:
# Asignar 1 a a
a = 1
# Asignar 2 a b
b = 2
# Sumar a y b
c = a + b

7. Conclusión

En Python puedes comentar varias líneas utilizando #, comillas triples o los atajos propios de cada entorno de desarrollo. El uso de # es el más directo y aplicable en casi cualquier situación, mientras que las comillas triples y los atajos ofrecen alternativas más eficientes en ciertos contextos. Con esta guía, podrás aplicar técnicas de comentado en Python de forma adecuada y disfrutar de un flujo de trabajo más eficiente y organizado.