RTFJD!

En donde JD = Javadoc. Una adaptación del famoso RTFM! (y no salgan con TL. DR por favor :P).

Si uno hace una clase en Java y se toma la molestia de escribir la documentación como se debe y de hacer el Javadoc, lo mínimo que esperas al momento de que le haces un cambio al código es que quien usa tu clase lea la documentación para ver qué cambió, sobre todo si le dijiste en persona que los cambios estaban hechos y documentados debidamente.

Una de las principales clases que he creado en mi trabajo (casi desde que entré, y de la que estoy 100% a cargo) ha sufrido cambios considerables. Y como en la empresa no conocían el concepto de “versión de software”, decidí levantar un servidor de svn en mi máquina. Así ha sido más fácil que el jefe baje el código nuevo una vez que ha sido modificado. También subí al svn el Javadoc. Total: esta clase de la que hablo regresaba, hasta el momento, un array de 2 LinkedList<String>. Bien pude haber regresado algo como LinkedList<LinkedList<String>>, pero como eran 2 listas máximo, preferí un arreglo. Sin embargo, en el cambio más reciente que me pidieron, ahora regreso un arreglo de 4 listas ligadas de strings. Termino la modificación de código, hago pruebas, veo que todo funciona, documento código, subo al svn la modificación.

Varias horas después, cuando el jefe tiene tiempo de probar el nuevo código, me dice “me da error, revisa qué pasa”. Y yo con cara de “¿eh? ¿En dónde le da error?” Al mostrarme su código, me di cuenta de que nunca escuchó que ahora el arreglo contenía 4 listas ligadas, y, por tanto, donde él usa mi código mandaba una ArrayIndexOutOfBoundsException.

Quizá de lo que más me puedo quejar de mi trabajo es que me exigen todo bien documentado… y no leen la documentación. No sé por qué me recuerda a cierto sensei en cierto laboratorio en cierta universidad (de la que me gradué); pero no digo nombres, porque si no yo mismo me enojo 😛