generar - generate javadoc eclipse

¿Cómo arreglar inteligentemente la documentación en Eclipse?

Question

De vuelta en mis días de C #, me encantó usar una extensión de Visual Studio llamada "GhostDoc". Ahora que estoy siendo utilizado como desarrollador de Java, estoy usando Eclipse. Puedo vivir sin poder tener documentación deducida, pero algo que me gustaría hacer es "arreglar" de manera inteligente mi documentación. Por ejemplo, supongamos que tengo el siguiente método:

/**
 * Gets a collection of {@link Foo} objects
 * @param bar The bar level
 * @param baz The bazziness
 */
public Collection<Foo> getFoos(int bar, int baz)
{
    // Do something cool
}

Más adelante en el desarrollo, me doy cuenta de que sería útil permitir que los consumidores de mi método pasen un valor qux. No solo eso, sino que tiene más sentido tenerlo como primer parámetro. También voy a hacer que el método lance mi súper útil FooBarException. Así que ahora mi método se ve así:

/**
 * Gets a collection of {@link Foo} objects
 * @param bar The bar level
 * @param baz The bazziness
 */
public Collection<Foo> getFoos(String qux, int bar, int baz) throws FooBarException
{
    // Do something cool
}

Siendo un buen desarrollador, quiero que mis cambios se reflejen en mi JavaDoc. En GhostDoc, podía pulsar la tecla de método abreviado de mi documento y agregaría las cosas nuevas sin alterar las cosas antiguas. En Eclipse, presenta un conjunto completamente nuevo de JavaDoc y tengo que hacer un montón de copiar pasta. ¿Cómo puedo incluir automáticamente el nuevo @param , @exception y el parámetro @returns faltante en mi JavaDoc sin perder el JavaDoc que tengo actualmente?

Answer 1

Eclipse admite "código" -compleción para JavaDoc también. No tienes que escribir la declaración de agujero. Solo tienes que escribir "@p" y CTRL + Space imprimirá el resto por ti. O incluso mejor, simplemente escriba el nombre del parámetro, el código completado agregará el resto.

No es directamente un atajo, pero puede acelerar el javadoc más rápido que escribir todo desde cero.

lo mismo para @t (@throw) @r (@return) y así sucesivamente.

Editar a tu comentario:

Puedes configurar Checkstyle, para revisar tus clases automáticamente. Checkstyle informará cuando su método tenga un parámetro no documentado o algún otro parámetro faltante. Checkstyle también puede verificar si su primera oración termina con un ''.'' o no. Usted puede muchas de estas reglas a mano.

Checkstyle agregará marcadores de problemas en su editor de código java y en su vista de problemas. Así que puedes encontrar fácilmente líneas de código, con problemas javadoc.

Answer 2

Escribir / ** encima de un lugar de comentario típico (los mismos lugares que con GhostDoc) completará automáticamente una plantilla para el comentario.

Si cambia el nombre de una variable utilizando la funcionalidad de cambio de nombre (Shift + Alt + R), Eclipse también cambiará los nombres en todos los lugares correctos, asumiendo que el código se compila.

Esto incluye y comenta los enlaces que has hecho.

/**
 *
 * My funky method
 *
 * @param myThing
 *         myThing is of type {@link MyThingClass}
 */
 public void myMethod(MyThingClass myThing) {}

Cambiar el nombre de myThing o MyThingClass usando la funcionalidad de cambio de nombre de Eclipse también actualizará estas referencias.

Del mismo modo, el uso de la funcionalidad "Cambiar método de firma" también actualizará sus comentarios.

Básicamente, si está refactorizando, use el menú de refactorización (Mayús + Alt + T).

Answer 3

No está seguro de si lo siguiente es lo que usted menciona, pero como eclipse tiene su propio Validador JavaDoc, puede configurar las Advertencias / Errores de compilación en

Ventana -> Preferencias -> Java -> Compilador -> JavaDoc.

Al activar las etiquetas javadoc faltantes según sus propias necesidades y configurar el nivel de advertencia en "advertencia", el compilador notará sus cambios y le avisará, tan pronto como su javadoc difiera de la firma de sus métodos. Para solucionarlo, ofrece una solución rápida (STRG + 1) y puede elegir agregar todas las etiquetas faltantes. Esta operación agregará las etiquetas que faltan, incluso en el lugar correcto, sin alterar su antiguo comentario.

Answer 4

Checkstyle ya fue mencionado. Lo intenté, pero pareció ralentizar mucho mi Eclipse (E4 juno, aunque es conocido por tener algunas ralentizaciones graves).

Google CodePro estaba haciendo un mejor trabajo, así que ahora estoy usando esto ahora.

Y, por supuesto, puede habilitar las advertencias de JavaDoc.

Answer 5

http://jautodoc.sourceforge.net/ funciona bien con Luna, así que consulte en el mercado