Doclets

De ChuWiki
Saltar a: navegación, buscar

Doclets de java

Cuando hacemos

javadoc fuentes.java

javadoc recoge la información en los fuentes de java y se la pasa a una clase java llamada Doclet. Esta clase es la encargada de generar la documentación de javadoc tal cual la conocemos. Tienes un ejemplo de documentación generada por javadoc en javadoc de librería gráfica en java

Sin embargo, es fácil cambiar esta clase Doclet por defecto por otra. Basta con hacérsela y compilarla y luego llamar a javadoc asi

javadoc -doclet MiClase -docletpath PathDeMiClase fuentes.java


Lo mejor de todo es que en http://www.doclet.com hay un montón de clases "Doclet" ya hechas que hacen montones de cosas, como generar la documentación añadiéndole un diagrama de clases automáticamente, generarla en pdf, xml o rtf, etc.

¿Y por qué no ir más allá?. Un Doclet no tiene porqué generar documentación. Con la información de los fuentes recibida puede hacer cualquier cosa. Hay Doclet también que revisan el estilo de código a ver si cumple las convenciones, que generan esqueletos de test para JUnit, que a partir de un bean java generan los EJBs necesarios, que generan ficheros html con los fuentes y la sintaxis coloreada, etc, etc, etc.

Enlaces