AutoDocumentar código con Jautodoc

AutoDocumentar código con Jautodoc
Fernando Barragán
Desarrollador Software e iOS
“El trunk no espera por nadie.”
Post más relevante: Uso básico del GIT con Eclipse

Para documentar código en Eclipse elegimos la opción del plugin Jautodoc

Para instalarlo vamos al marketplace de eclipse, lo buscamos y lo instalamos:

MarketPlace con Jautodoc

Una vez instalado y con su configuración por defecto ya podemos auto documentar cualquier clase con la combinación de teclas

CTRL + ALT + J

Clase Auto Comentada con Jautodoc

Usamos la combinación de teclas CTRL + ALT + J para auto documentar

 

Ahora bien, nos interesa hacer algunas mejoras, como por ejemplo quitar el TODO: Autogenerated Java Doc.

Si entramos en Window – Preferences – Java – Jautodoc podemos configurarlo a nuestro gusto.

En la web http://jautodoc.sourceforge.net/ nos explican detalladamente cada una de las opciones; no obstante repasaremos las opciones más relevantes:

Configuración de Jautodoc

Modo

  • Completar Javadoc existente
  • Mantener Javadoc existente
  • Reemplazar Javadoc existente

Según la opción que se elija se reemplazará toda la documentación auto generada cada vez que se pulse la combinación de letras de javadoc, se mantendrá la existente o se completará lo nuevo existente.

Visibilidad

  • Publico
  • Paquete
  • Protegido
  • Privado

Filtro

  • Comentar tipos
  • Comentar campos
  • Comentar métodos
    • Getters y Setters únicamente
    • Excluir Getters y Setters
    • Excluir Sobreescritos

Aquí elegimos qué métodos y qué partes de la clase queremos que se genere la auto documentación.

Opciones

  • Añadir TODO para Javadoc auto generado
  • Crear comentarios desde el elemento del nombre
  • Comentarios en linea única
  • Usar el formateador de comentarios de eclipse
  • Getters y Setters desde el campo comentario
  • Incluir subpaquetes

Aquí tenemos alguna opción interesante como el poder eliminar los TODO’s cada vez que autogeneramos código.

Añadir cabecera

Esta parte es muy interesante ya que nos interesa que cada clase tenga una cabecera con información de la empresa, creador y fecha de creación por ejemplo.

Si añadimos la siguiente plantilla por ejemplo:

Header File, Jautodoc

Conseguimos el efecto deseado.  La etiqueta ${date} ya nos la proporciona el propio eclipse. El tag $author lo incluimos nosotros en las propiedades.

Editar Propiedades en Jautodoc

Orden de los tags

  • Podemos editar el orden por defecto de los tags que se auto comentan

Reemplazar comentarios desde el nombre del elemento

En esta parte podemos colocar palabras que con las que se generará el código auto comentado a partir de nuestro código, por ejemplo:

  • En un CRUD es muy típico tener métodos que contengan las palabras add, create, edit o get; en estos casos Jautodoc por defecto sustuirá el comentario con Adds the, Creates the, Edits the o Gets the. Aquí podemos añadir todas las palabras que nos interesen sustituir.

Hasta aquí esta pequeña introducción al plugin de Eclipse Jautodoc, continuaremos hablando en próximos artículos de plugins interesantes para usar en eclipse.

Una opinión sobre “AutoDocumentar código con Jautodoc

Deja un comentario

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *