Es normal que usemos comillas triples para hacer comentarios multilínea en python, pero su uso no es correcto aunque veas en muchos tutoriales y cursos que los usan. La única forma correcta de comentar sería usando el numeral "#", no hay más.
Me explico: resulta que python no genera ningún error si escribes una cadena de strings con comillas triples si lo dejas al aire libre sin ser parte de una asignación a una variable.
Puedes hacer esto mismo con un par de comillas dobles o simples y no pasa nada.
python interpreta este tipo de comentarios como docstring, un tipo de comentario que sirve para la documentación de un código, similar a los comentario XML usado en el lenguaje C# para comentar funciones.
Haz la prueba y observará que esto no arroja ningún tipo de error, ahora prueba lo siguiente
Aquí estamos declarando una lenguajes, que es una lista de tuplas, con un comentario dentro; al hacer esto observamos que se genera un error porque está considerando el comentario como un tipo de objeto haciendo las veces de función, el intérprete se confunde y lanza este error. solo cambiemos el comentario por un numeral.
Ahora si observa ya no hay error, intentemos obtener los tipos de objeto para ver lo corroborar lo mismo.
Conclusión.
Quizás nunca se ha detenido a pensar que algunas cosas que parecen intuitivas no lo son tanto. Muchas veces me detuve a pensar el porque usar comillas triples como comentario, se podía usar a la vez como variable y a la vez se podia formatear usando %d para el reemplazo de variables, en mi cabeza esto no tenía sentido.
Tal vez este sea un blog algo tonto, pero ahora sabes que usar comillas sin asignar es un docstring. Espero que de todos modos haya sido de ayuda y que de ahora en adelante siempre comente usando un numeral "#"
Nos vemos en un siguiente blog
Comentarios