Comentarios en Python

En este momento estás viendo Comentarios en Python
  • Autor de la entrada:
  • Categoría de la entrada:Python
  • Tiempo de lectura:2 minutos de lectura

Los comentarios son fundamentales para documentar el código y hacer que sea más comprensible. En este tutorial veremos cómo utilizar comentarios en Python.

¿Qué son los comentarios?

Los comentarios son fragmentos de texto en el código que no se ejecutan y se utilizan para explicar o documentar lo que hace el código. Esto ayuda a otros (o a ti mismo en el futuro) a entender mejor el propósito y la lógica detrás del código.

Tipos de comentarios en Python

En Python, hay dos tipos principales de comentarios:

  1. Comentarios de una sola línea
  2. Comentarios de varias líneas

Vamos a ver como utilizar cada uno de ellos.

Comentarios de una sola línea

Los comentarios de una sola línea comienzan con el símbolo #. Todo el texto que sigue a este símbolo en la misma línea será ignorado por el intérprete de Python.

Ejemplo:

# Este es un comentario de una sola línea
print("Hola, mundo!")  # Esto imprime un mensaje en pantalla

Comentarios de Varias Líneas

Los comentarios de varias líneas se pueden hacer utilizando comillas triples (»’ o «»»). Esto permite incluir comentarios que ocupen más de una línea. Aunque no es su uso principal, Python también permite que las cadenas multilínea se utilicen como comentarios, siempre y cuando no se asignen a ninguna variable.

Ejemplo:

"""
Este es un comentario de varias líneas.
Puede incluir múltiples líneas de texto.
Python ignorará todo esto.
"""
print("Hola, mundo!")

Buenas Prácticas de Comentarios

Para que los comentarios sean realmente útiles, considera las siguientes buenas prácticas:

  1. Sé claro y conciso: los comentarios deben ser fáciles de entender. Evita la jerga innecesaria.
  2. Explica el por qué, no el qué: a menudo, el código es autoexplicativo en cuanto a lo que hace. Los comentarios deben explicar por qué se tomó una decisión o se realizó una acción determinada.
  3. Mantén los comentarios actualizados: si cambias tu código, asegúrate de actualizar o eliminar los comentarios relacionados para evitar confusiones.
  4. Usa comentarios para secciones de código: puedes usar comentarios para separar lógicas o secciones de tu código, lo que facilita la lectura.
  5. Evita comentarios obvios: no comentes cosas que sean evidentes. Por ejemplo, no es necesario comentar x = x + 1 con “Incrementa x en 1”.
Artículos Relacionados
Orlando José-Rivera
Últimas entradas de Orlando José-Rivera (ver todo)

Deja una respuesta