Comentarios en Python

Cuando escribes código, tarde o temprano sentirás la necesidad de incluir algunas palabras dirigidas no a Python, sino a los humanos. Ya sea para explicarle a otro programador cómo funciona un truco complejo en el script, detallar el propósito de una variable, o dejar registro de quién es el autor y cuándo se escribió el programa.

Una anotación insertada en el código fuente que el intérprete ignora por completo en tiempo de ejecución se conoce formalmente como comentario.

¿Cómo se escribe un comentario en Python?

Para evitar que Python intente interpretar tus notas humanas como órdenes o comandos, debes usar el símbolo # (almohadilla, hash o gato).

Cada vez que Python se topa con un signo # en el programa, todo lo que esté escrito a la derecha de ese símbolo se vuelve completamente invisible y transparente para él. Desde el punto de vista técnico del intérprete, un comentario equivale simplemente a un espacio en blanco, sin importar lo largo que sea.

Comentarios de una o varias líneas

Un comentario en Python se extiende estrictamente desde el signo # hasta el final de la línea actual. Si necesitas redactar un comentario que abarque varios renglones, debes colocar un signo # al inicio de cada uno de ellos.

# Este programa calcula la hipotenusa c.
# a y b son las longitudes de los catetos.
a = 3.0
b = 4.0
c = (a ** 2 + b ** 2) ** 0.5  # Usamos ** en lugar de una función de raíz raíz.
print("c =", c)

Como ves en el ejemplo, existen dos formas de colocar comentarios:

  1. Bloque independiente: Ocupando líneas completas al inicio para dar contexto.
  2. Línea interna (inline comment): Colocado a la derecha de una instrucción de código (c = ... # Usamos ). Python ejecuta la matemática de la izquierda e ignora la nota de la derecha.

El Código Autodocumentado: La Mejor Práctica

Los desarrolladores profesionales y responsables acostumbran a describir los fragmentos importantes de sus sistemas. Sin embargo, la comunidad de Python defiende una regla de oro: la mejor manera de comentar una variable es asignándole un nombre que no deje lugar a dudas.

Si creas una variable diseñada para almacenar el área de un terreno, el nombre area_terreno es infinitamente superior a ponerle caja_1 o tia_juana. Un nombre bien elegido se considera autodocumentado (self-commenting), lo que reduce drásticamente la necesidad de llenar tu archivo de textos explicativos redundantes.

Comentarios como Herramienta de Depuración (Testing)

Los comentarios tienen otra utilidad estratégica vital: te permiten “desactivar” temporalmente líneas de código que no necesitas en un momento dado o que sospechas que están provocando un fallo.

# Este es un programa de prueba.
x = 1
y = 2
# y = y + x
print(x + y)

Truco Pro de Productividad (Atajo de Teclado)

Escribir el signo # línea por línea en bloques largos de código puede ser tedioso. Los editores de código modernos y los entornos de desarrollo (IDEs) incluyen un atajo universal sumamente útil:

  • Windows / Linux: Selecciona las líneas que deseas modificar y presiona CTRL + /
  • Mac OS: Selecciona las líneas y presiona CMD + /

Este comando funciona como un interruptor (toggle): si las líneas no tienen comentario, les añade el # automáticamente; si ya están comentadas, les quita el signo de inmediato.