miércoles, 31 de mayo de 2017

Una apología de la documentación del código



La documentación del código es una de esas tareas cuya realización resulta tediosa y suele evitarse pero que, a la larga, paga dividendos o, más bien, evita los costes de la no documentación.

Y en este caso la defensa de la documentación del código proviene no de un metodólogo o de un ingeniero de software, no al menos en un sentido tradicional, sino de Field Cady, un científico de datos quien, en su libro, 'The Data Science Handbook' afirma: 

Everybody who writes code is responsible for making sure that their code is clear.

No sólo una buena práctica, sino una responsabilidad. Documentar el código lo hace más legible no sólo para terceros (por ejemplo, otro desarrollador que deba evolucionarlo o encontrar un bug) sino para el mismo autor del código quien, probablemente, cuando hayan transcurrido unas semanas desde que lo realizó, también le cueste entender su propio código.

Documentar el código lo hace más mantenible y más evolucionable. Más barato, por tanto, aunque en una forma difícil de cuantificar.

La claridad, la legibilidad, no sólo del código, sino también de cualquier documento, mensaje, ayuda  o manual son atributos insoslayables. 

Más allá de una buena práctica, una responsabilidad...pocas veces asumida...