En esta entrega, vamos a profundizar en el fino arte de comentar código.
En principio… ¿por qué deberíamos comentar nuestros códigos?
Quiero empezar citando a Ryan Campbell:
“comentar el código es como limpiar el cuarto de baño; nadie quiere hacerlo, pero el resultado es siempre una experiencia más agradable para uno mismo y sus invitados”
Poner comentarios en el medio de código sin gramática, va mucho mas allá de escribir /* */ por cada línea explicando el funcionamiento de procesos tan obvios como estúpidos. Se requiere casi un “don” para poder explicar en pocas palabras el funcionamiento de algoritmos complejos a otras personas que no seamos nosotros mismos.
¿Que objetivo tiene este artículo?… vamos a intentar comunicarnos con nuestro “yo del futuro”. ¿Estoy loco? no no, hablo de que hagamos código que podamos leer cuando lo agarremos en el futuro (1 año después por ejemplo).
Mi biblioteca de archivos viejos, contiene códigos fuente ilegibles e inentendibles para mi “yo del presente”. Y eso es porque en el pasado, tenia “otra mente” (no, no es que fui abducido por extraterrestres) en el sentido de que mi mente ha evolucionado y ya no recuerdo mi modo de pensar en ese tiempo, por lo tanto, las soluciones y algoritmos que me parecian obvios ya no lo son tanto ahora.
En este artículo voy a tratar de responder estas preguntas: ¿Cómo comentar? ¿Que comentar? y ¿Los comentarios mejoran la calidad del software?
Leer más »