Comentarios en programación son los fragmentos de texto más útiles que brindan información breve sobre el código en particular. Puede usar comentarios en su código para ayudar con la documentación. Mantendrá a alguien informado sobre lo que ha escrito. El concepto de comentarios en la programación puede ayudar a los equipos de trabajo dinámicos a comprender qué código ha sido escrito por equipos anteriores y mucho más. Ahora, estamos aquí para hablar sobre los comentarios en python y, junto con esto, podemos hablar de todo sobre los comentarios. ¡¡¡Vamos a rodar!!!
¿Por qué deberías usar comentarios mientras codificas?
Puede utilizar los comentarios para diversos fines. Mantiene su código limpio, legible y bien documentado. He indicado algunas aplicaciones de los comentarios en la codificación.
- Para planificar y revisar su código:
Sí, como sugiere el nombre, puede escribir el pseudocódigo usando los comentarios antes de escribir el código fuente. Esta planificación no solo ayudará a documentar, sino que también hará que su código fuente sea mucho más fácil de leer.
- Descripción de su código:
Mientras codifica, puede hacer uso de los comentarios para escribir una descripción del funcionamiento del código o qué puede esperar de una línea de código en particular. Podemos ver los ejemplos en las últimas etapas del artículo.
Mientras codifica, puede insertar un carácter ASCII, logotipos y diagramas de flujo para una mejor comprensión o cualquier propósito particular. Pero, lo mejor es que puedes formatearlos como comentarios.
En el proceso de codificación, las declaraciones de impresión se utilizan a intervalos regulares para imprimir los valores para identificar los errores que ocurren. Más tarde, mediante el uso de comentarios, puede negar esas declaraciones impresas.
En la codificación, el mayor estrés será encontrar los errores y no poder entender los códigos escritos previamente por alguien. Los desarrolladores pasan la mayor parte del tiempo en esta fase. Pero el uso de comentarios para describir, documentar y depurar el código también puede facilitar y agilizar el trabajo.
¿Cómo comentar sobre el código de python?
Todo idioma tiene la comentando opción para mejorar la calidad del código, la legibilidad y la documentación. Python no es una excepción aquí. Puedes hacer comentarios en python. Antes de hacerlo, debe conocer los diferentes tipos de comentarios en python. Entonces, analicemos cada uno de ellos con ejemplos.
Comentarios de una sola línea en python
La característica básica de los comentarios de una sola línea en python es que comenzarán con “#” (Hashtag) sin espacios ni espacios en blanco. Tenga en cuenta que cuando el comentario excede una línea, debe usar otro hashtag en una nueva línea. Puede utilizar comentarios de una sola línea específicamente para descripciones breves, notas breves, declaraciones de funciones y más.
#This is my first python comment
#Print "Hackanons" in the output
print("Hackanons")Hackanons
Como puede ver, puede usar comentarios de una sola línea para hacer descripciones breves, y también puede escribir lo que hará la línea de código en particular.
Comentarios multilínea en python
Los comentarios de varias líneas en python se pueden ver como el texto encerrado entre un conjunto de delimitadores (” ” “). En los comentarios de una sola línea, utilizará # antes del texto. Pero aquí, debe encerrar su texto entre un par de delimitadores como se muestra. Debe dejar cualquier espacio entre los delimitadores. Los comentarios de varias líneas entrarán en la fiesta cuando los comentarios de una sola línea no sean suficientes para transmitir el significado.
"""
This is my first python multiline comment.
I just saw an article which explains the comments in python.
There I learnt how to use multiline comments in python.
Now I am printing, what I have learnt today.
"""
print("Today, I learnt about multiline comments in python")Today, I learnt about multiline comments in python
Puede utilizar este tipo de comentario para describir en detalle. Puedes añadir tantas líneas como quieras.
Comentarios de la cadena de documentación de Python
Los comentarios de Docstring son uno de los más útiles. tipos de comentarios en python. Este comentario debe agregarse debajo de la función, la clase o los métodos. Luego puede llamarlo más tarde usando el atributo _doc_ en la declaración de impresión. Vamos a ver cómo funciona.
def add(a,b):
"""Adds a with b"""
return a+b
print(add.__doc__)Adds a with b
¡Guau!. Puede ver el increíble tipo de comentario incorporado que funciona para usted.
Vamos a armarlo todo!!!
Hasta ahora, en python nos hemos encontrado con tres tipos de comentarios. Suponiendo que no tenga dudas sobre todo eso, estoy avanzando un poco y usando los tres comentarios en un solo código. Así obtendrá una imagen clara del funcionamiento de los comentarios de código.
"""
Over the past 10 minutes, we have learn about comments in python.
We have gone through 3 types of comments and thier usage.
Now, it's time to put it altogether.
Let's roll!!!
"""
def substract(a,b):
"""Substrcts value of a with value of b"""
return a-b
#Print the docstring comment output
print(substract.__doc__)Substracts value of a with value of b
Terminando
Comentarios son de los aspectos más útiles de la programación. Python admite 3 tipos de comentarios. Comentarios de una sola línea, de varias líneas y de cadenas de documentación. Hemos revisado los 3 tipos de comentarios con ilustraciones. Los comentarios en python agregan más valor a la calidad del código, la documentación, la depuración y la legibilidad también. Eso es todo por ahora, la próxima vez, otro tema. Pitón feliz!!!
