Comentarios en Python

1. Cómo escribir comentarios

En Python, como en muchos otros lenguajes de programación, puedes escribir comentarios en el código.

Los comentarios son solo texto para otros programadores: el intérprete de Python no les presta atención y no ejecuta el código que está en ellos. Los comentarios ayudan a los programadores y a otros miembros del proyecto a entender el código, lo cual es especialmente útil para trabajos en equipo y mantenimiento a largo plazo de programas. En Python hay varias formas de añadir comentarios al código.

Comentarios de una sola línea:

Comienzan con el símbolo #. Todo lo que aparece después de # en esa misma línea, el intérprete de Python lo ignora. Este tipo de comentarios se utiliza generalmente para observaciones o explicaciones breves sobre una línea específica de código. Ejemplo:

# Este es un comentario de una sola línea
print("¡Hola, Mundo!")  # Explicación sobre la acción de la función

Comentarios multilínea:

En Python no hay un soporte oficial para comentarios multilínea, pero puedes crearlos usando varios comentarios de una sola línea o utilizando comillas triples, aunque estas últimas en realidad son literales de cadena multilínea que no se ejecutan como código. Ejemplo:

# Este es un ejemplo de comentario multilínea
# Cada línea comienza con el símbolo `#`

o:

""" Este es un literal multilínea que puede usarse como comentario. Python lo interpreta como cadena, pero no hace nada con ella si no se asigna a una variable o no se utiliza en una expresión. """

¡Útil! Un literal es un pedazo pequeño de datos escrito directamente en el código: un número, una cadena, etc.

2. Por qué escribir comentarios

Usar comentarios en el código mejora su legibilidad, facilita el mantenimiento y la actualización, y contribuye a una colaboración más efectiva en los equipos. Los comentarios deben ser breves, pero informativos y relevantes, para servir como documentación útil del código y no llenarlo con información innecesaria.

Cadenas documentales (docstrings):

Estas son cadenas multilínea que generalmente se colocan al inicio de módulos, clases, métodos y funciones para describir su propósito. Se encierran en tres pares de comillas dobles y se utilizan para generar documentación automáticamente.

Ejemplo:

def add(a, b): """ Función para sumar dos números. :param a: primer sumando :param b: segundo sumando :return: suma de a y b """ return a + b 

En el mundo de la programación, los desarrolladores a veces añaden a su código comentarios que no solo sirven como explicaciones, sino que también sacan una sonrisa. Aquí tienes algunos ejemplos de comentarios divertidos que puedes encontrar en el código:

Ejemplo 1:

# Podría explicar qué pasa aquí, pero ni yo mismo lo entiendo ya.

Ejemplo 2:

# Si esto no funciona, es culpa de alguien más.

Ejemplo 3:

# Vine, vi, arreglé... y rompí.

Ejemplo 4:

# Cuando escribí esto, solo Dios y yo sabíamos cómo funcionaba.
# Ahora solo lo sabe Dios.

Ejemplo 5:

# Horas desperdiciadas aquí = 42.

Estos comentarios pueden añadir un toque de humor y ligereza al proceso de desarrollo, haciendo la base de código menos monótona. También recuerdan que el desarrollo de software es un proceso creativo y humano.

5.3 Comentar código rápidamente

En PyCharm IDE puedes comentar o descomentar código rápidamente utilizando atajos de teclado. Para hacerlo, selecciona las líneas de código que deseas comentar o descomentar, y presiona Ctrl + / en Windows (o Cmd + / en macOS). Esta combinación de teclas aplica o elimina el símbolo de comentario en cada línea seleccionada, haciendo este proceso rápido y eficiente.