Comentarios de Python

Comentarios de Python

Los comentarios son las líneas en un programa de computadora que ayudan a construir una mejor comprensión de la funcionalidad del sistema. En cualquier lenguaje de programación, los comentarios se escriben en lenguaje natural y de manera legible. No se ejecutan en lugar de que el compilador o intérprete los ignore. Los comentarios en Python se utilizan para varios fines. 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 un cierto código. Los comentarios hacen que el código sea más legible y nos ayudan a recordar por qué se agrega un código y cuál es su propósito previsto.

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, entonces es posible que no agregue los comentarios porque comprende el propósito de escribir un bloque específico de código. Pero, si otro programador quiere actualizar el código, entonces no es tan fácil para él comprender 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 comprender el código y tomará más tiempo. Pero si ha escrito correctamente los comentarios con cada bloque de código, entonces los desarrolladores recién contratados comprenderán fácilmente el código existente. Inicialmente, escribir y mantener los comentarios lleva algún tiempo, pero ahorra mucho tiempo en el futuro.

Los comentarios promueven la reutilización del código: Cuando desarrollamos sistemas de software similares, reutilizar lo existente es la mejor práctica. Ahorra mucho de nuestro esfuerzo y tiempo. Al reutilizar el código, primero verificamos qué componentes tenemos que reutilizar. Tenemos que entender la funcionalidad del componente 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:

  1. Comentarios de una sola línea
  2. Comentarios en línea
  3. Comentarios de múltiples líneas

Comentarios de una sola línea

Los comentarios de una sola línea se escriben en breve 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 se imprime en la consola de Python. En la salida, solo se imprime "Hello World". El comentario es ignorado por el compilador.

En un bucle for, los comentarios son como este

Comentarios en línea

Los comentarios en línea se escriben al final de la línea de código. En un simple programa de "Hello World", el comentario en línea es como este

El comentario en línea en un bucle for bucle es así:

Comentarios multiline

Python no proporciona una forma distinta de escribir los comentarios de múltiples líneas. Podemos escribir comentarios multiline en Java, C, C ++ y C# Pero en Python, no hay una forma separada de escribir comentarios de múltiples líneas. Los comentarios múltiples se usan generalmente para explicar el bloque complejo del código. En los comentarios múltiples, cada línea comienza con # Mark. 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 comprender 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.