Comentarios en Lenguajes de Programación
Es curioso que la tarea que peor se acostumbra a hacer en los trabajos de programación es el comentario del código fuente y la documentación de la aplicación, lo que a ojos de un profano pasaría por lo más fácil, pues consiste en explicar qué se ha hecho y porqué.
Todos los lenguajes de programación proporcionan a los desarrolladores mecanismos para introducir comentarios en el código fuente.
Estos comentarios son textos que no se ejecutan y que, por lo tanto, no deben constar en ningún formato determinado, salvo para indicarle al compilador dónde empiezan y dónde acaban.
Al no tener que ser ejecutados, los comentarios tampoco son compilados siendo útiles tan solo para el código fuente.
El papel esencial de los comentarios es hacer legible y comprensible el código fuente.
Para entender su papel, pondremos un ejemplo: al leer un programa, podemos preguntarnos qué hace una variable concreta. Si al declararla, hemos comentado el rol de aquella variable, y al utilizarla hemos añadido un comentario del porqué de su uso, no nos será necesario retroceder en el código una y otra vez para entender la función de aquella variable.
Igualmente, los comentarios deben explicar cualquier acción o conjunto de acciones, las variables y las llamadas a procedimientos externos.
Los comentarios son indispensables cuando se trabaja en grupo, especialmente si el equipo no tiene un contacto fluido.
Los proyectos de programación son de esas tareas que pueden ser llevadas a cabo con cada uno de los participantes a distancia, pero pese a que existen herramientas como la videoconferencia para poder estar en contacto casi permanente, sigue siendo indispensable poder entender lo que los otros han escrito sin necesidad de tener que preguntárselo.
Además, en los proyectos que aúnan a varios desarrolladores -y, por lo tanto, con una cierta entidad e importancia-, los comentarios también pueden ejercer otras funciones o ayudar a solventar determinadas necesidades.
Y si prevemos que en el futuro otros desarrolladores pueden incorporarse al trabajo o incluso tomar sus riendas, comentar abundantemente una aplicación es la única forma de quien se suma al proyecto pueda entender lo realizado antes de su llegada. Sobretodo si quienes lo han llevado a cabo se marchan.
El uso de comentarios también es positivo para uno mismo; ¿recuerdas los apuntes que tomabas en clase y que, al cabo de un tiempo, ya ni tu mismo entendías? Pues la programación puede ser algo parecido… excepto si al leer los comentarios que anotaste te acuerdas de por qué creaste aquellas líneas de código.
Los comentarios existentes en el programa pueden ayudar a crear la documentación de este.
Al incluir comentarios ya con esta visión en el código, posteriormente la tarea de documentación de la aplicación (que a los programadores acostumbra a desagradarles tener que hacer) se automatiza bastante.
También se utiliza el recurso de comentar líneas de código en tareas de depuración.
Por ejemplo, cuando probamos la solución a un problema que provoca un error en tiempo de ejecución, en vez de sustituir la o las líneas de código que creemos afectadas eliminándolas o sustituyéndolas, lo que hacemos es comentarlas para que no se ejecuten, y escribimos otras que, funcionalmente, las sustituirán.
De esta forma, no perdemos la solución original que habíamos creado, pudiendo tomarla como referencia para crear otra más depurada que no incurra en el error de ejecución que nos provocaba la anterior.
Existen diferentes ‘etiquetas’ para comentar un programa, formas de escribir los comentarios.
La norma, no obstante, sigue siendo clara: que el comentario sea explicativo de lo que hace el código.
Al empezar, he dicho que comentar los programas es una de las tareas que peor acostumbran a hacer los desarrolladores. Eso es debido a varios motivos: el primero es que muchas veces el perfil del programador es el de una persona a la que no le gusta escribir (por lo menos en prosa, algo fuera del lenguaje de programación), y el segundo principal motivo es porque muchas veces se van probando soluciones sobre la marcha que no se documentan en el momento porque se está demasiado concentrado en solucionar el problema.
Esto lleva a que el comentario a posteriori sea una tarea añadida que da pereza hacer, y es así como muchas veces se pasa de puntillas sobre ella.
Foto: Fotolia – McCarony
Por Guillem Alsina, el 21/01/2019.
Siguiente