🐍Comentarios

Los comentarios son una parte fundamental de cualquier lenguaje de programación. Permiten describir partes del código que desarrollamos de manera que sea mucho más facil de comprender.

En Python existen diferentes tipos de comentarios que podemos utilizar para documentar nuestro código.

1. Comentarios básicos

La manera más básica de poner comentarios en Python es utilizando el símbolo #

In [1]:

# Esto es un comentario en Python

También podemos poner comentarios después de alguna sentencia en Python

var = "Hola mundo" 
# Variable que contiene una cadena de texto

Los comentarios en Python deben ser cortos y transmitir información relevante para el desarrollador. No debe saturarse el código de un número muy elevado de comentarios que no transmiten información significativa.

2. Comentarios de varias líneas

En algunas ocasiones es posible que necesitemos poner comentarios de varias líneas. Python no permite crear un comentario de varias líneas utilizando el símbolo #.

# Esto es un comentario
de varias líneas
en Python

  Cell In[3], line 2
    de varias líneas
       ^
SyntaxError: invalid syntax

La forma más sencilla de poner comentarios de varias líneas en Python, es comenzar cada una de las líneas con el símbolo #

# Esto es un comentario
# de varias líneas
# en Python

Otra forma existente para definir comentarios de múltiples líneas en Python consiste en situar el texto entre """. Como ya hemos comentado en secciones anteriores, esta construcción realmente esta creando un string de varias líneas.

var = "Hola mundo"

""" 
Esto es un comentario
de varias líneas
en Python
"""

var
'Hola mundo'

Mientras que esto le da la funcionalidad de multilínea al comentario, debemos tener claro que no es técnicamente un comentario. Es una cadena que no está asignada a ninguna variable, por lo que será ignorada en tiempo de ejecución y no aparecerá en el bytecode de tu programa.

Sin embargo, debemos tener cuidado con el uso de este tipo de comentarios multilínea. Dependiendo de dónde se sitúen en nuestro programa, podrían convertirse en docstrings, que es un tipo de documentación que se asocian a una función o método.