1. Inicio
  2. Pregunta y respuesta
  3. ¿Hay alguna herramienta para actualizar Javadoc automáticamente?

¿Hay alguna herramienta para actualizar Javadoc automáticamente?

2009-12-07 27 views
5

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:¿Hay alguna herramienta para actualizar Javadoc automáticamente?

/** 
* 
* @ 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.

Fuente

2009-12-07 machineghost

+0

P.S. Intenté buscar una pregunta como esta en SO ya (ya que esperaba que hubiera habido una), pero después de vagar cientos de preguntas todavía no se me ocurrió nada, así que ... nueva pregunta :-) – machineghost

Respuesta

3

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.

Fuente

2009-12-07 19:59:49

+1

Por defecto (al menos en ** Netbeans 8.0.2 **) esta herramienta ** no ** encontrará errores en JavaDoc en métodos privados. Para cambiar el alcance de ** Analice Javadoc ** vaya a 'Herramientas -> Opciones -> Editor -> Sugerencias -> JavaDoc -> Error en Javadoc -> Alcance' y cambie el alcance a privado. –

3

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'.

Fuente

2009-12-07 19:52:53

+0

Lo intenté esto (aunque marqué la solución de NetBeans como la respuesta, porque parece más poderosa, personalmente soy un usuario de Eclipse). Sin embargo, ninguna de las advertencias aparece en problemas :-(Cuando veo una de ellas, tiene una línea ondulada amarilla debajo, pero incluso cuando le digo a Eclipse que valide ese archivo, sigo sin obtener nada en la ventana de problemas. ideas sobre lo que podría estar haciendo mal? – machineghost

Cuestiones relacionadas

 Cuestiones relacionadas