Elementos del lenguaje – Comentarios
En la mayoría de los lenguajes de programación, existe la posibilidad de insertar comentarios en el código, esta es una práctica que mientras el programa esta en desarrollo suele ser muy recomendable utilizar, ya que permite realizar observaciones y anotaciones en el texto que aclaran el desarrollo del programa.
Los comentarios en el lenguaje Python, pueden ser dos tipos, de una sola linea o de múltiples lineas y se expresan de la siguiente forma en el código.
Si se quiere insertar un comentario de una sola linea en el código, la linea ha de comenzar con el símbolo #, seguidamente dejar un espacio en blanco y escribir el comentario, teniendo en cuenta que este no puede abarcar más de una linea.
También se pueden insertar comentarios de una sola linea en la misma linea que una de código. Pero se ha de tener en cuenta que en este caso se han de dejar dos espacios en blanco justo después del código, insertar el símbolo # y dejar un espacio en blanco después del mismo, escribiendo a continuación el comentario.
En los comentarios es común también utilizar palabras justo después del espacio en blanco dejado en el comentario, que sirvan para indicar que acciones se quieren realizar como programador, aclarando así conceptos en la programación del código. Estos términos pueden ser por ejemplo TODO, que significa que hay algo que hacer, FIXME, que significa que se ha de corregir un error y XXX que significa lo mismo.
Para crear un comentario de lineas múltiples ha de utilizar el símbolo de comillas tres veces seguidas «»», para empezar el comentario, a continuación escribir las lineas que componen todo el comentario y para cerrar el comentario volver a teclear tres veces seguidas el símbolo de comillas «»».
A continuación se muestran algunos ejemplos de comentarios en el código.
# Este es un comentario de una sola línea
variable_uno = 100
"""Este es un comentario
de líneas múltiples"""
variable_dos = 200
# TODO comentario de línea con termino de acción.
