En este tutorial, aprenderemos a crear comentarios en Python con la ayuda de ejemplos.
Video: Comentarios en Python
Los comentarios son descripciones que ayudan a los programadores a comprender mejor la intención y la funcionalidad del programa.
Son completamente ignorados por el intérprete de Python.
Ventajas de usar comentarios
El uso de comentarios en programas hace que nuestro código sea más comprensible. Hace que el programa sea más legible, lo que nos ayuda a recordar por qué se escribieron ciertos bloques de código.
Aparte de eso, los comentarios también se pueden usar para ignorar algún código mientras se prueban otros bloques de código. Esto ofrece una forma sencilla de evitar la ejecución de algunas líneas o escribir un pseudocódigo rápido para el programa.
Comentarios de una sola línea en Python
En Python, usamos el símbolo de almohadilla #para escribir un comentario de una sola línea.
Ejemplo 1: escribir comentarios de una sola línea
# printing a string print('Hello world')
Salida
Hola Mundo
Aquí, el comentario es:
# printing a string
El intérprete de Python ignora esta línea.
Todo lo que viene después #se ignora. Entonces, también podemos escribir el programa anterior en una sola línea como:
print('Hello world') #printing a string
La salida de este programa será la misma que en el Ejemplo 1 . El intérprete ignora todo el texto posterior #.
Comentarios de varias líneas en Python
Python no ofrece una forma separada de escribir comentarios de varias líneas. Sin embargo, existen otras formas de solucionar este problema.
Podemos usar #al principio de cada línea de comentario en varias líneas.
Ejemplo 2: uso de varios #
# it is a # multiline # comment
Aquí, cada línea se trata como un solo comentario y todos se ignoran.
Literales de cadena para comentarios de varias líneas
Aunque no existe una forma única de escribir comentarios de varias líneas en Python, sabemos que el intérprete de Python ignora los literales de cadena que no están asignados a una variable.
Entonces, incluso podemos escribir un comentario de una sola línea como:
#this is a comment 'this is an unassigned string as a comment '
Aquí, podemos ver que la segunda línea del programa es una cadena pero no está asignada a ninguna variable o función. Entonces, el intérprete ignora la cadena.
De manera similar, podemos usar cadenas de varias líneas (comillas triples) para escribir comentarios de varias líneas.
El carácter de la cita puede ser 'o ".
Ejemplo 3: uso de literales de cadena para escribir comentarios de varias líneas
''' I am a multiline comment! ''' print("Hello World")
Aquí, la cadena de varias líneas no se asigna a ninguna variable, por lo que el intérprete la ignora. Aunque técnicamente no es un comentario de varias líneas, se puede utilizar como uno.
Cadenas de documentación de Python
Por convención, las comillas triples que aparecen justo después de la función, método o definición de clase son cadenas de documentación (cadenas de documentación).
Las cadenas de documentos están asociadas con objetos y se puede acceder a ellas mediante el __doc__atributo.
Para obtener más información, visite las cadenas de documentación de Python.
¿Cómo escribir mejores comentarios?
- Utilice comentarios para describir lo que hace una función y no los detalles específicos sobre cómo lo hace.
- Intente eliminar tantos comentarios redundantes como sea posible. Intente escribir código que pueda explicarse a sí mismo, utilizando una mejor opción de nombre de función / variable.
- Intente que los comentarios sean lo más breves y concisos posible.
