Apoyando el Software Libre, a un mundo libre!

Aqui voy a mostrar las ventajas que tiene usar NetBeans con Javadocs, las cuales son muchas. Pero primero, vamos a explicar lo que es Javadocs.

Javadocs

Es una herramienta que nos provee el SDK de Java para generar la documentacion de nuestras ropias clases, de manera rapide y efectiva. Lo que que hace javadocs es basicamente tomar los comentarios marcados de manera especifica y los enlaza, generando una pagina en formato HTML con todos los comentarios, dependencias y parametros de clases, atributos y metodos que se encuentren en el codigo. Al ejecutar java docs sobre un codigo bien comentado, quedara al mismo estilo que la documentacion de la API de Java.

Comentarios, al puro estilo Javadocs

Los comentario que procesa Javadocs se estructuran así:

/**
* Este comentario sera procesado por Javadocs
* @etiqueta [dato_opcional] Etiqueta procesada por Javadocs
*
*/
// Aqui el codigo que corresponde el comentario de arriba

Lo anterior, y como es la idea de Javadocs, es que el código fuente este muy enlazado a los comentarios, cosa de que la documentación sea clara y comprensible para quien la lee. TambiénJavadocs procesa etiquetas, y de acuerdo a ellas, y su contenido, genera informacion mas precisa. No es obligatorio ponerlas, pero si se quiere buena documentación, si lo son.

Javadocs con NetBeans

¿Que tiene de bueno? Muchas cosas, es tan simple como 2 clicks para generar toda la documentacion, sin contar los asistentes que nos ayudan a comentar bien nuestro codigo y nos avisan en caso de estar incompletos. Los principales objetos de Javados en NetBenas son:

Auto comment... : Es un asistente que analiza todas las clases, subclases, atributos y metodos, verificando que esten bien comentados, asi como permitirnos agregar comentarios facilmente. Lo encontramos en en menu 'Tools' -> 'Auto comment'. Tambien podemos desplegar esta herramienta haciendo click con el boton secundario en un archivo .java, seleccionando el manu 'Tools' y luego 'Auto comment'.

Generate Javadocs for Proyect : Genera la ayuda javadocs para todas las clases de nuestro proyecto. Podemos hacer que la genere en el menu 'Build'->'Generate Javadocs for [proyecto]' o bien, desplegando el menú contextual en el nombre el proyecto y clickear en 'Generate Javadocs for proyect'.


También, dentro del proyecto, al examinar el código fuente, encontraremos en la ventana de propiedades una clausula que nos permitirá insertar comentarios Javadocs a gusto, así como etiquetas, dependiendo de donde se encuentre el cursos del editor de código.

Así al colocar el cursos en el cuerpo de un método de una clase, con permitirá documentar ese método especifico. Si nos colocamos fuera de un método o atributo, pero dentro de la clase, podremos documentar la clase en si.


Espero, nuevamente sea de su agrado esto y que tenga mucha utilidad. Good Bytes!!