Estaba programando un código en Java, y me ha surgido la idea, de tener que crear un JavaDoc, es decir, una documentación para mi código Java, para ello tenía dos opciones:

- O bien crearla a mano

- O utilizar la opción que me da JavaDoc, para ello, solamente en eclipse, sirve con empezar en ved de el comentario por /*, comenzar el comentario por /**, es decir, doble asterisco, de estar forma estaremos creando un JavaDoc.

Las variables, que podemos colocar en el JavaDoc, serían:

- @version – Para indicar la versión de nuestro programa

- @return – Para indicar lo que devuelve la función

- @author – Para indicar el autor del documento.

- @param, para indicar los parámetros de los métodos.

Estos son algunos parémetros o variables, para introducirlas dentro del JavaDoc, pero siempre, se puede utilizar también código HTML, dentro del JavaDoc, para editar algo a nuestro gusto, como etiquetas de negrita, o de nuevo parrafo.

Después de crear el JavaDoc, para generarlo, desde la linea de comandos:

 javadoc nombrearchivo.java

 Esto generará, un archivo .html, que será nuestro JavaDoc.

Si disfrutaste nuestro artículo, siéntete libre de suscribirte a nuestro feed rss