LOS COMENTARIOS

SENDERO JUNTO AL BARRANCO DE RUIZ, SAN JUAN DE LA RAMBLA. NORTE DE TENERIFE

      Un COMENTARIO desde el punto de vista de Python es una explicación escueta o apunte que podemos añadir a nuestros programas conforme los vamos elaborando para saber en todo momento qué estamos haciendo, por qué y cómo. De esta manera tendremos siempre constancia (y el control) de lo que estamos codificando y, subsecuentemente, instruirá a cualquier otro programador que esté leyendo nuestro programa, en tanto que no siempre vamos a ser sólo nosotros quienes manejemos un programa, incluido el nuestro.

En consecuencia, un comentario no sólo nos ayuda a clarificar el código sino que también nos va a refrescar la memoria cuando, pasado el tiempo, tengamos que actualizar (refresh) nuestros programas. También nos ayudará a que otro/s programador/es, leyendo nuestros comentarios, nos proponga nuevas ideas, mejoras, alternativas interesantes que contribuyan a optimizar nuestro producto.

En general, el uso de comentarios de manera habitual en nuestros programas constituye una buena práctica, más que recomendable, para mantener el control de la programación y promocionar nuestro trabajo.

Para incluir comentarios en nuestros scripts, Python admite dos formas posibles: una primera para notificaciones, apuntes o comentarios cortos que van asociados a una única línea de código y que se escriben justo al final de la misma utilizando la siguiente sintaxis:

                

   >>>  LÍNEA DE CÓDIGO  # (almohadilla) comentario

C95

Como podemos ver se muestran de manera predeterminada en rojo, igual que las excepciones con las que Python gusta de aguarnos la experiencia de programar. Esto es así porque el lenguaje reserva este color para toda información que deba ser interpretada por el programador/usuario, salvo los resultados que, como ya sabemos, se nos devuelven en azul. También, como podemos ver en nuestro ejemplo, es posible sumar comentarios línea a línea aunque esta opción, por así decirlo, no resulta estéticamente recomendable ni tampoco cuenta con el apoyo del PEP8, un paradigma de estilo consensuado (no oficial) para los programadores de Python.
Una segunda opción, óptima para comentarios más extensos, pasa por recurrir a la triple comilla que ya conocemos, la "triple quote", permitiendo al programador escribir cuantas líneas considere necesarias para completar su comentario. En este caso, como es de esperar, se mostrará en verde dado que se trata de una cadena de caracteres literales o string. Recordemos que sólo se mostrarán en pantalla de cara al usuario potencial de nuestro programa si lo pasamos como argumento de la función print() y, según la ocasión, como ya se verá, con la instrucción return.
En este último caso, tenemos la base estilística de lo que se denominan en Python DOCSTRINGS, un tipo especial de comentario que introducimos en las funciones definidas (construidas) por el usuario y, en algunos casos, en los módulos, con una estructura particular, y de la que ya hablaremos en su momento.

BOSQUE DE LAURISILVA EN SAN JUAN DE LA RAMBLA, NORTE DE TENERIFE