Phenquestions
Los comentarios son las líneas de un programa informático que ayudan a comprender mejor la funcionalidad del sistema. En cualquier lenguaje de programación, los comentarios se escriben en lenguaje natural y de forma legible por humanos. No se ejecutan, sino que son ignorados por el compilador o el intérprete. Los comentarios en Python se utilizan para varios propósitos. En este artículo, le explicaremos cómo puede agregar comentarios en Python.
Beneficios de usar comentarios en Python
Los siguientes son los beneficios de usar comentarios en Python:
Los comentarios hacen que el código sea más legible: Mientras desarrolla un programa de computadora, el programador escribe múltiples clases y miles de líneas de código. A veces, el programador olvida por qué se escribe una determinada pieza de código. Los comentarios hacen que el código sea más legible y nos ayudan a recordar por qué se agrega un fragmento de código y cuál es su propósito.
Los comentarios mejoran la comprensión del código: Los comentarios nos ayudan a comprender por qué se agrega un determinado bloque de código en el programa y cuál es su propósito. Si un programador escribe un bloque de código, es posible que no agregue los comentarios porque comprende el propósito de escribir un bloque de código específico. Pero, si otro programador quiere actualizar el código, entonces no es tan fácil para él entender el código en minutos. Entonces, cuando agregamos los comentarios, ayuda a otros programadores a comprender el código. Supongamos que está trabajando en el proyecto Python. Fue el proyecto de tamaño mediano inicialmente. Pero por ahora, su empresa para mejorar este proyecto y traer más desarrolladores y programadores para escribir el código. Si no ha escrito los comentarios en su programa, verá que será muy difícil para ellos entender el código y tomará más tiempo. Pero si ha escrito correctamente los comentarios con cada bloque de código, los desarrolladores recién contratados comprenderán fácilmente el código existente. Inicialmente, escribir y mantener los comentarios lleva algo de tiempo, pero le ahorra mucho tiempo en el futuro.
Los comentarios promueven la reutilización del código: Cuando desarrollamos sistemas de software similares, la mejor práctica es reutilizar el existente. Nos ahorra mucho esfuerzo y tiempo. Mientras reutilizamos el código, primero comprobamos qué componentes tenemos que reutilizar. Tenemos que entender la funcionalidad del componente en particular. Los comentarios nos ayudan a comprender la funcionalidad del componente y promueven la reutilización del código.
Escribir comentarios en Python
Escribir los comentarios en Python es muy fácil. Los comentarios en Python comienzan con la marca #. En Python usamos tres tipos de comentarios:
- Comentarios de una sola línea
- Comentarios en línea
- Comentarios de varias líneas
Comentarios de una sola línea
Los comentarios de una sola línea se escriben brevemente en una sola línea. Los comentarios de una sola línea transmiten el propósito de escribir una función específica o una línea de código. En un programa simple, el comentario es así:
Producción
La salida está impresa en la consola de Python. En la salida, solo se imprime "Hello World". El compilador ignora el comentario.
En un bucle for, los comentarios son así
Comentarios en línea
Los comentarios en línea están escritos al final de la línea de código. En un programa simple "Hola mundo", el comentario en línea es así
El comentario en línea en un bucle for es así:
Comentarios multilínea
Python no proporciona una forma distinta de escribir los comentarios de varias líneas. Podemos escribir comentarios de varias líneas en Java, C, C ++ y C #, pero en Python, no hay una forma separada de escribir comentarios de varias líneas. Los comentarios de varias líneas se utilizan generalmente para explicar bloques de código complejos. En los comentarios de varias líneas, cada línea comienza con la marca #. Si queremos escribir varias líneas de comentarios, cada línea comenzará con una marca # como esta:
Conclusión
Los comentarios son muy útiles en el programa Python. Nos ayuda a entender el programa. Hace que los programas de Python sean más legibles para los humanos. Los comentarios promueven la reutilización de los programas existentes. En este artículo, hemos visto tres formas de agregar comentarios en Python. Al usar estas tres formas, puede hacer que sus programas de Python sean más legibles, comprensibles y reutilizables.
