Comentarios en Python son las líneas del código que el intérprete ignora durante la ejecución del programa.
# I am single line comment> > > ''' Multi-line comment used> print('Python Comments') '''> |
significado de dhl
>
>
Los comentarios mejoran la legibilidad del código y ayudan a los programadores a comprenderlo con mucho cuidado. También ayuda a colaborar con otros desarrolladores, ya que agregar comentarios facilita la explicación del código.
Tipos de comentarios en Python
Hay tres tipos de comentarios en Python:
- Comentarios de una sola línea
- Comentarios multilínea
- Literales de cadena
- Comentarios de cadena de documentos
Comentarios en Python
En el ejemplo se puede observar que Pitón El intérprete ignora los comentarios durante la ejecución del programa.
Python3
# sample comment> name>=> 'geeksforgeeks'> print>(name)> |
>
>
Producción:
geeksforgeeks>
¿Por qué se utilizan comentarios en Python?
Los comentarios han sido una parte integral de los lenguajes de programación y cada lenguaje tiene diferentes formas de usarlos.
Al igual que cualquier otro lenguaje, los comentarios en Python tienen el siguiente propósito:
- Mejorar la legibilidad del código
- Explicar el código a otros
- Comprender el código si se estudia después de un tiempo
- Documentar los pasos y las necesidades de una función.
- Compartir código con otros desarrolladores
- Colaborando con varias personas.
Tipos de comentarios en Python
Descubramos los diferentes tipos de comentarios, ¿cómo usarlos y cuándo usarlos?
1. Línea única Comentarios
- El comentario de una sola línea de Python comienza con el símbolo de hashtag (#) sin espacios en blanco y dura hasta el final de la línea.
- Si el comentario excede una línea, coloque un hashtag en la línea siguiente y continúe con el comentario de Python.
- Los comentarios de una sola línea de Python resultan útiles para proporcionar explicaciones breves sobre variables, declaraciones de funciones y expresiones. Vea el siguiente fragmento de código que muestra un comentario de una sola línea:
Ejemplo:
Python3
árboles extendidos
# Print techcodeview.com ! to console> print>(>'techcodeview.com'>)> |
>
>Producción
techcodeview.com>
2. Comentarios de varias líneas
Python no ofrece la opción de comentarios multilínea . Sin embargo, existen diferentes formas de escribir comentarios multilínea.
a) Comentarios de varias líneas que utilizan varios hashtags (#)
Podemos utilizar varios 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.
Python3
# Python program to demonstrate> # multiline comments> print>(>'Multiline comments'>)> |
cómo convertir una cadena en int
>
>Producción
Multiline comments>
Verifique también: Dato interesante sobre los comentarios multilínea de Python
3. Literales de cadena
Python ignora el literales de cadena que no están asignados a una variable, por lo que podemos usar estos literales de cadena como comentarios de Python .
a) Comentarios de una sola línea usando cadenas literales
Al ejecutar el código anterior podemos ver que no habrá ningún resultado, por lo que usamos las cadenas con comillas triples () como comentarios de varias líneas.
Python3
los 10 mejores hentai
'This will be ignored by Python'> |
>
>
b) Comentarios multilínea utilizando cadenas literales
Python3
''' Python program to demonstrate> >multiline comments'''> print>(>'Multiline comments'>)> |
>
>Producción
Multiline comments>
4. Cadena de documentos
- Cadena de documentación de Python son los literales de cadena con comillas triples que aparecen justo después de la función.
- Se utiliza para asociar documentación que ha sido escrita 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 cadena de documentación está disponible a través del atributo __doc__.
Ejemplo:
Python3
Actriz Rakul Preet Singh
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>
Ventajas de los comentarios en Python
Los comentarios se utilizan generalmente para los siguientes propósitos:
- Legibilidad del código
- Explicación del código o Metadatos del proyecto
- Prevenir la ejecución de código
- Para incluir recursos
Manera correcta de escribir comentarios
Los comentarios tienen como objetivo principal explicar su código. Los desarrolladores utilizan prácticas saludables de redacción de comentarios para comprender mejor el código.
Algunos de los consejos que puedes seguir, para que tus comentarios sean efectivos son:
- Los comentarios deben ser breves y precisos.
- Utilice comentarios sólo cuando sea necesario, no satura su código con comentarios.
- El comentario debe tener algún significado.
- Evite escribir comentarios genéricos o básicos.
- Escriba comentarios que se expliquen por sí solos.
Hemos discutido todo sobre los comentarios de Python, cómo escribir comentarios de Python, los tipos de comentarios, cuáles son sus ventajas y la forma correcta de escribir comentarios.
Lea también: ¿Cómo escribir comentarios en Python3?