Comentarios de Python

Los comentarios en Python son las líneas del código que el intérprete ignora durante la ejecución del programa. Los comentarios mejoran la legibilidad del código y ayudan a los programadores a entender el código con mucha atención. Hay tres tipos de comentarios en Python: 

• Comentarios de una sola línea
• Comentarios multilínea
• Comentarios de la string de documentación

Ejemplo: Comentarios en Python

# Python program to demonstrate comments
 
# sample comment
name = "geeksforgeeks"
print(name)

Producción: 

geeksforgeeks

En el ejemplo anterior, se puede ver que el intérprete ignora los comentarios durante la ejecución del programa.

Los comentarios se utilizan generalmente para los siguientes propósitos: 

• Legibilidad del código
• Explicación del código o metadatos del proyecto
• Impedir la ejecución de código.
• Para incluir recursos

Tipos de comentarios en Python

Hay tres tipos principales de comentarios en Python. Están: 

Comentarios de una sola línea

El comentario de una sola línea de Python comienza con el símbolo del hashtag (#) sin blanco y dura hasta el final de la línea. Si el comentario excede una línea, coloque un hashtag en la siguiente línea y continúe con el comentario. Se ha demostrado que los comentarios de una sola línea de Python son útiles para proporcionar explicaciones breves de variables, declaraciones de funciones y expresiones. Consulte el siguiente fragmento de código que muestra un comentario de una sola línea:

Ejemplo: 

# Print “GeeksforGeeks !” to console
print("GeeksforGeeks")

GeeksforGeeks

Comentarios de varias líneas

Python no ofrece la opción de comentarios de varias líneas . Sin embargo, existen diferentes formas a través de las cuales podemos escribir comentarios de varias líneas.

Usando Hashtags Múltiples (#)

Podemos múltiples hashtags (#) para escribir comentarios de varias líneas en Python. Todas y cada una de las líneas se considerarán como un comentario de una sola línea.

Ejemplo: comentarios de varias líneas con varios hashtags (#)

# Python program to demonstrate
# multiline comments
print("Multiline comments")

Multiline comments

Uso de literales de string

Python ignora los literales de string que no están asignados a una variable, por lo que podemos usar estos literales de string como un comentario . 

Ejemplo 1:

'This will be ignored by Python'

Al ejecutar el código anterior, podemos ver que no habrá ningún resultado, por lo que usamos las strings con comillas triples («»») como comentarios de varias líneas.

Ejemplo 2: comentarios de varias líneas usando literales de string

""" Python program to demonstrate
 multiline comments"""
print("Multiline comments")

Multiline comments

String de documentación de Python

Python docstring son los literales de string con comillas triples que aparecen justo después de la función. Se utiliza para asociar documentación que se ha escrito con módulos, funciones, clases y métodos de Python. Se agrega justo debajo de las funciones, módulos o clases para describir lo que hacen. En Python, la string de documentos está disponible a través del atributo __doc__.

Ejemplo:

def multiply(a, b):
    """Multiplies the value of a and b"""
    return a*b
 
 
# Print the docstring of multiply function
print(multiply.__doc__)

Producción: 

Multiplies the value of a and b