¿Hay alguna herramienta para actualizar Javadoc automáticamente?

Question

Trabajo en una base de código que es ... desordenada. Un aspecto de este desorden es que tenemos un montón de métodos cuyas firmas ya no coinciden con el Javadoc asociado. Por ejemplo:

/** 
* 
* @ param foo 
*/ 
public void doFoo(int bar) {... 

No soy un fan de Javadoc generada (ya que casi siempre es inútil), pero realmente podría utilizar una herramienta que ir a través de nuestro código, encontrar casos como ese, y:

1. eliminar el Javadoc para el parámetro "foo"
2. añadir javadoc para el parámetro "barra" (pero sólo una en blanco, sin doc generada automáticamente o cualquier cosa)

¿existe una herramienta de este tipo? Si no, ¿existe una herramienta que simplemente hace # 1? Incluso eso reduciría significativamente la cantidad de advertencias de basura que obtenemos en nuestras compilaciones. Gracias.

Answer 1

NetBeans tiene una herramienta para eso. Hace exactamente lo que preguntas.

Puedes también hacer clic en el menú Tools, entonces Analyze Javadocs desde la parte superior, o haga clic derecho en un archivo y haga clic en Tools, entonces Analyze Javadocs.

Esto le proporciona una lista de todos los problemas que encuentra con sus Javadocs con una opción para corregirlos. Le permite corregir un problema único en un método, corregir los javadocs para el método, para el archivo, para el paquete o para todo el proyecto.

Answer 2

Una solución, si está utilizando eclipse, es ir a Window -> Preferences -> Java -> Compiler -> Javadoc y luego establecer la variable 'Comentarios Javadoc malformados' en advertencia o error.

Luego puede ir a la vista de problemas Window -> Show View -> Problems y luego en cada error, haga clic derecho y seleccione 'Solución rápida'.

Answer 3

No he probado ninguno de estos además de DocCheck, pero this somewhat-dated page on Sun's site enumera varios doblts de terceros, algunos de los cuales pretenden insertar Javadoc en su fuente. De ellos, puede echar un vistazo a Doc-o-Matic, JRefactory Pretty Printer y ACTOS Auto Commentator for Java. Nuevamente, no he probado ninguno de estos, pero es un buen lugar para comenzar.