Cómo escribir los comentarios en los archivos de código python
Video: Comentarios y como Crear script ejecutable - Curso Python (3)
Escribir los comentarios en los archivos de código Python es una buena cosa porque se puede comunicar mensajes a su propio futuro en el texto del programa. Vamos a echar un vistazo a un archivo de código de ejemplo.
""Esto es sólo un archivo de prueba""print ( `Hola mundo desde el editor`)
La primera línea que aquí se denomina comentario. Parece que los literales de cadena, porque eso es lo que es. Cuando Python ve una cadena literal en un archivo lo ignora! En este caso, usted se está diciendo que este fichero es simplemente un archivo de prueba, lo que no debería ser demasiado disgustado si te equivocas.
Video: Tutorial Python 34 - Archivos
Usted tiene un montón de buenas razones para escribir comentarios en el código:
A modo de explicación. Siempre que se crea un nuevo archivo de Python, escribir una breve explicación de lo que el código tiene que hacer. No repita lo que el código está haciendo. Resumir lo que el código es para. ¿Qué quieres lograr? Por lo tanto, en el código a = a + 1 # añadiendo 1 a una el comentario no tiene sentido, ya que cualquier tonto puede ver que el código es la adición de 1 a a. Por lo general, no deseas incluir un comentario aquí a menos que hubiera una razón que no está claro a partir del código. Por ejemplo: a = a + 1 # Cambio de un provoca que los datos se actualizan en el siguiente bloque de código.
Como ayuda para la memoria. Cuando se intenta por primera escribir el código que está muy cerca de ella. Usted está familiarizado con él. A entender por qué usted ha puesto lo que usted ha puesto dónde y por qué. A medida que pasa el tiempo, va a olvidar por qué pones ese pedazo de código en algún lugar. Es mucho más fácil de leer una descripción de trabajar hacia fuera más adelante.
Como medio de comunicación. Cuando usted da su código a otra persona, una explicación Inglés de lo que hace el código es aún más importante. Comentarios le permiten colaborar (Trabajar juntos) mejor con los demás. Si quieres trabajar como parte de un equipo de programación, es mejor que tengas buenos comentarios en el código.
Como una ayuda de depuración. Si hay un problema con su código, alguien tendrá que ir y arreglarlo, y puede que no sea usted. Una vez más, tener una explicación Inglés de lo que está pasando es una gran ayuda.
Porque es bueno para usted. Al igual que las verduras, sólo el más sabroso.