Páginas

lunes, 11 de abril de 2011

TODO, FIXME...

FIXME

En ocasiones los desarrolladores utilizamos anotaciones especiales en los comentarios del código para ayudar a encontrar algunos problemas comunes. De hecho, algunas de estas anotaciones están tan extendidas que incluso los entornos de desarrollo permiten resaltarlas de manera especial, o proveen de utilidades específicas para su localización.

Algunas de estas anotaciones podrían ser:

FIXME
para marcar el código potencialmente problemático que requiere especial atención y/o revisión
NOTE
para documentar el funcionamiento interno de código e indican posibles dificultades
TODO
para indicar posibles mejoras previstas
XXX
para advertir a otros programadores de código problemático o posiblemente erroneamente planteado.

Si te fijas, verás que las anotaciones que he indicado reflejan el conjunto de chapuzas y/o parches cuyos arreglos se van postponiendo a lo largo del desarrollo, o lo que es lo mismo, reflejan la deuda técnica del Proyecto.

Para evitar el riesgo de que estas anotaciones se acumulen con el tiempo (de que la deuda técnica se acumule) se pueden utilizar diversas técnicas, siendo las más habituales:

  • incluir la fecha y el propietario de etiquetas en la etiqueta de comentario para facilitar su seguimiento
  • llevar un diario de deuda técnica en el que ir marcando aquella "deuda" con la que nos encontramos más a menudo
...lo cual, en ambos casos, nos dará una indicación de qué debemos ir arreglando. Por lo que sólo nos quedaría, llegados a este punto, ir solucionando cada uno de estos "problemas"... pero para eso ya está tu pericia como desarrollador, ¿no crees?

No hay comentarios:

Publicar un comentario