sábado, febrero 05, 2005

JavaDoc!!!!

Esta es una herrmienta muy útil, sobre todo para nosotros los de la carrera de Sistemas que casi nunca documentamos lo que hacemos.
Eclipse, proporciona una interfaz bastante amigable para la generacion de esta documentación. Aun me falta mucho por aprender de esta herramienta, pero lo que pude apreciar fue que hay que especificar "tags" (autor, version, etc.) si se desea información detallada, o simplemente colocar comentarios sobre cada función, ya que esta es una parte de la informacion que se desplegara.
Una vez que se ejecuta "Javadoc" se generan una serie de Paginas Web, entre las cuales está un índice, un página de ayuda y una página por cada clase que pertenece al proyecto. Esta página de cada clase, contiene descripción de la clase, de sus métodos, constructores, etc.
En general nos proporciona información detallada de lo que programamos, de una manera fácil y rápida.
Ahora me gusta esto de documentar.