Como les decía es probable que por falta de tiempo u otras cuestiones no coloquemos comentarios en nuestro código, probablemente si estamos hablando de una aplicación muy simple o pequeña, a lo largo de un tiempo podremos leer dicho código sin ningún problema. Es problema surge cuando la complejidad del programa crece y las versiones van cambiando.
Para tener en cuenta:
- Es importante agregar los comentarios en la Cabecera de cada archivo de nuestro código fuente con una breve descripción de lo que encontramos en dicho archivo, y muchas veces suele colocar en esta parte del archivo un fragmento de la licencia escogida para el código, el o los nombres de los programadores encargados, la fecha de creación y modificación, algo importante es la versión.
- En otro lugar en donde nos vendría fantástico colocar comentarios es en aquellas funciones complejas, para tener algún modo de recordarlas o de saber que es lo que realizan.
- Es importante no llegar al abuso de los comentarios, si bien es una herramienta de documentación bastante importante y que no influyen para nada a la hora de interpretar o compilar sus códigos, pero aveces se puede tornar molesto ver tanta documentación.
Es por ello que les recomiendo llegar a un equilibrio, intentar trabajar con Comentarios discretos, y que describan el archivo, y lo máximo de prolijidad en nuestro código fuente hace que no tengamos que utilizar tantos comentarios.
Daniel M. Maldonado
Recuerda que seguimos publicando artículos periódicamente, así que no te olvides de suscribirte a nuestro Feed RSS si no quieres perderte ninguno de nuestros informes.
No hay comentarios.:
Publicar un comentario