jueves, 4 de mayo de 2023

Generar JavaDoc con maven

Hay una manera rapida y eficaz para poder generar la documentacion javadoc usando maven. 

Recordar que tu codigo debe tener los siguientes comentarios

 /** 

         Ejemplo de documentacion JavaDoc 

*/ 

 

Se debe ejecutar el siguiente comando: mvn javadoc:javadoc

 Esto generara la documentacion en la siguiente carpeta target/site/apidocs 

Puedes cambiar la carpeta por medio de la configuracion del plugin en la siguiente entrada reportOutputDirectory 

Espero que les sirva de ayuda Recordar que es importante la documentacion para el resto de los desarrolladores que van a mantener tu codigo.

No hay comentarios: