Cuando estás programando, independientemente del lenguaje, es posible hacer notas de trabajo, para recordarte a ti mismo sobre el código que escribes, o más importante, para dejar constancia de qué hace una parte del código, qué esperas obtener de una variable, o qué información está procesando una función.
Son líneas que no se ejecutan ni imprimen cuando corres tu programa, pero realmente son útiles para no perderte en tu propio código.
En Python existen dos formas de escribir estos comments:
– Empleando un hashtag (#)
– Usando triples comillas para delimitar tu idea («»» … «»»)
El uso del hashtag (o «gato» para los cuates) es bastante sencillo, puedes escribir tu comentario en cualquier sitio de tu código, siempre y cuando inicie con #, como se aprecia en la imagen a continuación.
Nota en la línea 11, que elegí comentar no al inicio de una línea propia, sino al final de una operación. En este caso es recomendable dejar un espacio razonable para el comentario, pero me di cuenta que funciona incluso con un solo espacio.
Por otro lado, encontré que el uso de las triples comillas es controversial. En algunos lugares se menciona que funciona para hacer comentarios en bloques, que son más largos que una línea, y sirven para explicar más a detalle qué hace una parte de tu código. Lo intenté, como pueden ver en la siguiente imagen, pero algo llamó mi atención: el comentario no aparece en color gris.
Esto me pareció curioso al inicio, y es que aunque no aparece en color gris, cuando corres el programa no te menciona que haya algún error ni tampoco lo imprime. ¿Pero por qué no estaba en color gris?
Me di a la tarea de investigar un poco más y encontré que algunos sitios donde se menciona que es incorrecto decir que en Python existen dos maneras de escribir comentarios. Así que investigué más a profundidad y descubrí que en la página de Python.org se menciona textualmente que los comentarios en bloque deben escribirse también con un hashtag en cada línea.
Sin embargo, sí existe el uso de las triples comillas. Simplemente se llaman documentation strings y precisamente el uso que se les da, es para explicar para qué funciona una parte de tu código.
Aquí la prueba, pueden encontrarlo en
https://www.python.org/dev/peps/pep-0008/#block-comments
Finalmente, ambos funcionan perfectamente, así que es decisión de cada quien cuál de los dos emplear 🙂
TC1017 #Learning Python 