Cómo Comentar un Bloque de Código en Python

plaintext
Los comentarios son una de las herramientas más útiles al trabajar con Python. Nos guían a través de la lógica, decisiones y propósitos detrás de bloques de código sin interferir con la ejecución. Los comentarios ayudan a que el código sea más legible y mantenible y facilitan la colaboración en un entorno de equipo.

Este tutorial profundizará en dos métodos eficaces para comentar varias líneas de código en Python, asegurando que tu código esté bien documentado y fácil de entender.

¿Por qué son importantes los comentarios de bloque en Python?

Los comentarios suelen ser uno de los primeros conceptos que encuentras en tu viaje de aprendizaje de Python. Proporcionan contexto útil sobre la intención detrás de un determinado fragmento de código. Ofrecen claridad y contexto sobre por qué un script se comporta de una determinada manera. Existen varias razones importantes por las que siempre deberías usar comentarios en tus scripts. Aquí tienes cuatro de ellas:

• Documentación: Los comentarios actúan como una forma de documentación que explica el propósito de funciones, clases o bloques de código. Esto es especialmente útil para algoritmos complejos donde la lógica no sea inmediatamente aparente.
• Legibilidad: Un código bien comentado es más fácil de leer y comprender. Esto es crucial cuando tú o otros vuelven a visitar el código después de algún tiempo.
• Depuración: Comentar temporalmente secciones de código es una práctica común para aislar y identificar errores.
• Colaboración: En un entorno de equipo, los comentarios hacen que el código sea más compartible y comprensible, facilitando una colaboración y revisiones de código más fluidas.

Uso de Comentarios de Línea Única en Python

Antes de profundizar en cómo comentar varias líneas, comencemos con lo básico de los comentarios de línea única. En Python, un comentario de línea única comienza con el símbolo de almohadilla (#), y el intérprete de Python ignora todo lo que sigue en esa línea. Para crear un comentario de línea única, siga las instrucciones a continuación:

1. Ubicación: Coloque el símbolo # al principio de la línea o después del código en la misma línea. Los comentarios pueden colocarse encima del código que describen, a la derecha del código en la misma línea, o de forma independiente.
2. Contenido: Después del símbolo #, escriba su comentario. Esto puede ser una explicación de la línea de código, una nota para referencia futura, o cualquier información útil relacionada con el código.

# Este es un comentario de línea única que explica la siguiente línea de código
print("Hello, world!")  # Esto imprime un mensaje en la consola

Método #1: Comentar Utilizando Varios # de Línea Única

La manera más directa de comentar en Python es utilizando el símbolo #, que anula todo lo que sigue en la línea. Aunque Python no tenga una sintaxis específica para los comentarios de bloque, puede usar múltiples # para comentar cada línea individualmente. Solo necesita realizar los siguientes pasos:

1. Identifique el bloque de código: Primero, identifique el bloque de código que desea comentar. Esto podría ser una función, un bucle o cualquier segmento de código que desee deshabilitar o explicar.
2. Comente cada línea: Coloque un # al inicio de cada línea que desee comentar. Esto le dice a la interpretación de Python que ignore estas líneas durante la ejecución.

Puede ver el ejemplo más abajo:

# Ejemplo de comentar múltiples líneas individualmente 
# def example_function(name):
#	# Esta función imprime "Hello " y el nombre de entrada
# 	print("Hello", name)

Método de Comentario de Bloque de Python #2: Comentario utilizando literales de cadena triplicada

Un método alternativo para comentar multiples líneas es utilizar literales de cadena de tres comillas (”’ ”’ o “”” “””). Aunque no sean oficialmente comentarios de bloque, estos literales de cadena se utilizan a menudo como tales, especialmente para comentarios de varias líneas o docstrings. Para utilizar las cadenas de tres comillas, simplemente coloque ”’ o “”” antes y después del bloque de código que desea comentar, como en este ejemplo:

'''
def example_function(name):
	print("Hello", name)
'''

Los literales de cadena de tres comillas se utilizan principalmente para documentar funciones de Python. Por ejemplo:

# Crear example_function()
def example_function(name):
	'''
	This function takes as input a name, and returns a salutation to the name in the form of "Hello name"
	'''
	# Imprimir la salida
	print("Hello", name)

Estos literales de cadena de tres comillas se denominan docstrings — puede leer más sobre ellos en nuestro tutorial de docstrings.