Comentarios de Python

Introducción

Esta guía no se trata de programación. De hecho, no hay un nuevo código involucrado en absoluto. Sin embargo, tiene todo que ver con asegurarse de que el código que escriba sea comprensible tanto para usted como para cualquier otra persona que pueda mirarlo en el futuro.

Si ha observado algún proyecto de código abierto, probablemente haya notado notas colocadas por los programadores. Esas notas son solo texto plano. El lenguaje de programación no los compila ni los interpreta de ninguna manera. Simplemente los ignora. Sabe que esos comentarios son para humanos, no de computadoras.

Los comentarios son muy importantes. Incluso si no compartes tu código con nadie más, te encontrarás con una instancia en la que miras hacia atrás en algo que escribiste hace mucho tiempo y te preguntes: "¿Qué hice aquí??"Si está interesado en trabajar en un proyecto de código abierto, que, lo más probable es que esté, ya que está leyendo esto en un sitio web de Linux, comentar es aún más importante. Lo último que desea es que su compromiso sea rechazado porque no se comenta y el mantenedor no quiere perder el tiempo descubriendo lo que hace. Los comentarios también son importantes en las secuencias de comandos del sistema. Hay muy pocos departamentos de TI para una sola persona, y sus compañeros de trabajo no serán felices si no saben lo que está pasando en sus guiones.

Comentando en Python

Al igual que muchos otros idiomas, Python tiene dos tipos diferentes de comentarios, solteros y múltiples líneas. Los comentarios de una sola línea son excelentes para agregar un comentario rápido antes de un bloque de código o justo después de una línea de código que explica lo que hace. Los comentarios de varias líneas son útiles para agregar un encabezado o una descripción más detallada a una pieza de código. También son excelentes para comentar un bloque de código para que no se ejecute, lo cual es excelente para la depuración.

Comentarios de una sola línea

En Python, un comentario de una sola línea comienza con un #. Este es un símbolo bastante común para usar en idiomas de secuencia de comandos. Aquí hay un ejemplo de cómo usaría un comentario de una sola línea como descripción.

a = 10 b = 15 a = b # establece una impresión igual a B (a + b) 

El código se ejecutará exactamente como lo haría si el comentario no estuviera allí. El comentario está ahí para ti.

También puede usar un comentario de una sola línea para decir lo que hará las próximas líneas de código.

# Importar la biblioteca de matemáticas Importar matemáticas # Ejecute el teorema de Pitagorean a = 3 b = 4 c = matemáticas.sqrt (a ** 2 + b ** 2) 

Aunque es un ejemplo simple que probablemente podría descubrir jut mirándolo, los comentarios hacen que mirarlo mucho más rápido. Imagine el tiempo que se ahorraría en un proyecto más complejo.

Ahora, eche un vistazo a cómo puede usar un comentario de una sola línea para evitar que se ejecute una línea de código.

a = 10 b = 15 # a = b ¿Qué sucede si a no está configurado igual a b impresión (a + b) 

La línea que establece a igual a b no se ejecutó, dando un resultado diferente al ejemplo anterior

Comentarios de múltiples líneas

En Python, puedes denotar un comentario de múltiples líneas usando "" " antes y después del código que desea comentar. Por supuesto, también puede usar esto para comentarios de texto más largos como la información del encabezado.

"" "Python Test Autor = su nombre Last actualizado = 1 de noviembre de 2016 Versión de Python - 3.4.3 Número de versión = 1.0.0 "" " 

Nada de eso significa nada para una computadora, pero es excelente para documentar el progreso de un proyecto. Mantener información como esa en los archivos del proyecto no afecta el programa real, pero usted y cualquier otra persona que trabaje en el proyecto tenga un acceso rápido y fácil a la información vital. Esto es excelente para documentar proyectos de colaboración con múltiples archivos y múltiples autores. Recuerde que la mayoría de los proyectos del mundo real serán complejos, por lo que documentar su código de esta manera es un buen hábito para entrar en.

Los comentarios de varias líneas también son esenciales para la depuración. Digamos que acaba de implementar una nueva función en su proyecto, pero ese nuevo código está causando un error. Puede comentar secciones completas para probar la funcionalidad de la nueva función Piece por pieza, hasta que finalmente descubra dónde está el problema. Digamos que el ejemplo de "teorema de pitagorean" desde arriba fue parte de una característica que estaba fallando. Podrías hacer algo como el código a continuación.

# Importar la biblioteca de matemáticas Importar matemáticas "" "Fallando - Por favor, debug # Ejecute el teorema de Pitagorean a = 3 b = 4 c = sqrt (a ** 2 + b ** 2)" "" " 

También puede usar comentarios de varias líneas para detener un viejo código mientras lo reemplaza. Solo eliminar el código no suele ser la mejor práctica. Después de todo, una vez que lo eliminas, se ha ido. Comentarlo que el código evite que se ejecute, pero también lo conserva como una referencia o retroceso en caso de que necesite verlo nuevamente.

Conclusión

El código de comentar es importante. Eso no puede ser exagerado. Puede parecer tedioso y aburrido. No tiene el destello de escribir una nueva línea asesina que implementa una característica, pero a la larga, estarás feliz de que esos comentarios estén ahí. Los comentarios también son una herramienta de depuración invaluable que puede proporcionarle un procedimiento sólido para probar un código fallido. Sigue practicando usando comentarios y viendo cómo pueden afectar el flujo del código al eliminar las líneas o los bloques de código.

Tabla de contenido

1. Guía de introducción e instalación de Python
2. Archivos de python y el intérprete
3. Experimentar con números y texto en Python
4. Variables de pitón
5. Trabajar con variables numéricas en Python
6. Python String Basics
7. Cuerdas avanzadas de pitón
8. Comentarios de Python
9. Listas de Python
10. Métodos de la lista de Python
11. Listas multidimensionales de Python
12. Python tuples
13. Operadores booleanos de Python
14. Python si las declaraciones
15. Python mientras bucle
16. Python para bucles
17. Diccionarios de Python
18. Diccionarios avanzados de Python
19. Funciones de Python

Tutoriales de Linux relacionados:

• Expresiones regulares de Python con ejemplos
• Instale Arch Linux en VMware Workstation
• Cómo trabajar con la API REST de WooCommerce con Python
• Cómo construir una aplicación Tkinter utilizando un objeto orientado ..
• Cómo gestionar los repositorios de GIT con Python
• Tutorial de depuración de GDB para principiantes
• Bash Regex avanzado con ejemplos
• Cosas para instalar en Ubuntu 20.04
• Bash Loops con ejemplos
• Sistema colgado de Linux? Cómo escapar a la línea de comando y ..