¿Cómo puedo actualizar automáticamente el Javadoc al cambiar la firma del método en Eclipse?

Estoy usando Eclipse IDE para mi proyecto Java.¿Cómo puedo actualizar automáticamente el Javadoc al cambiar la firma del método en Eclipse?

Tengo un problema. Tengo los métodos en mi proyecto que tienen los comentarios Javadoc como de la siguiente manera:

/** 
* Retruns the string representation of a input stream 
* @param in 
* @return 
* @throws IOException 
*/ 
public static String getStringFromInputStream (InputStream in) throws IOException { 
    StringBuffer out = new StringBuffer(); 
    byte[] b = new byte[4096]; 
    for (int n; (n = in.read(b)) != -1;) { 
     out.append(new String(b, 0, n)); 
    } 
    return out.toString(); 
}

Ahora quiero saber que ¿Hay alguna manera de que cada vez que si hago cambios en la firma de mi método, esos cambios se reflejan en el javadoc automáticamente

Fuente

2010-02-14 Yatendra Goel

Puede ser bueno para cambiar el título de esta. No hay problema con javadoc como dice el título. Tal vez algo como "Refactorización de JavaDoc cambia en Eclipse". No creo que puedas hacer esto sin escribir un plugin, por cierto. –

** ¡Aún está abierto para responder! **. Todas las respuestas se refieren a la opción de refactorización. Pero, ¿qué sucede si agregué un nuevo parámetro o borré un parámetro de la firma del método? En ese caso, ¿cómo actualizar el javadoc? – mtk

¡Chicos revisen mi respuesta para encontrar una solución! – mtk

Prensa Atl+Shift+R y cambiar

Fuente

2010-02-14 12:58:21

Solo funciona con nombres de parámetros. Los cambios de firma también incluyen agregar/quitar parámetros, cambiar la cláusula throws, etc. – whiskeysierra

Técnicamente, este es solo el comando [para 'Refactor'>' Rename'] (http://www.n0sl33p.org/dev/eclipse_keys.html) – Pops

No conozco ninguna forma de sincronizar automáticamente el encabezado Javadoc, pero si cambia el nombre de un parámetro usando Ctrl-1 + Rename in file, el encabezado Javadoc se renombra apropiadamente.

Fuente

2010-02-14 06:55:18 JesperE

Eclipse ofrece bastante buenas opciones para garantizar la exactitud de javadoc además de la refactor Renombrar JesperE mencionó:

La firma operación refactor Cambio método también modifica javadoc (añadir/quitar las etiquetas necesarias). Debe usar este o Renombrar para modificar el código que ya están en uso.

Si activa Añadir etiquetas Javadoc en Preferencias/Java/Editor/Escribiendo página, entonces Eclipse genera el talón javadoc correcta después de escribir /** + Introduzca antes de un método.

También puede configurar las opciones del compilador para comprobar las etiquetas Javadoc desapareció el Preferencias/Java/Compilador/Javadoc. En este caso, recibe advertencias del compilador sobre etiquetas faltantes/adicionales y tiene quickfix (Ctrl + 1) para solucionarlas. Es una buena opción para garantizar la corrección de los javadocs existentes a largo plazo.

Fuente

2010-02-14 07:23:52

Refactoring con la opción "Actualizar referencias" no es suficiente. Debe asegurarse de que "Procesar comentarios de Javadoc" esté marcado en Ventana-> Preferencias, Java-> Compilador-> Javadoc. Ajusta la página de preferencias como prefieras y funcionará bien.

Fuente

2014-04-03 08:17:22 Mat

Como ya he comentado el escenario, en el que refactor no funcionará

Todos responden refieren opción de refactorizar. Pero, ¿qué sucede si agregué un nuevo parámetro o borré un parámetro de la firma del método? En ese caso, ¿cómo actualizar el javadoc?

Hay una solución que he encontrado, pero sí todavía no es un proceso automático y no es bueno para gran número de cambios.

La solución es,
1. Retire el comentario Javadoc y crea Comentario llanura es decir, actualizar el /**' and change it to just/*'.
2. Ahora, una vez más, justo encima de la firma/declaración del método, ingrese /** y presione enter. Volvería a poblar los parámetros actualizados y la información de devolución.Ahora solo mueve las líneas de descripción del comentario anterior al nuevo.
3. Puede utilizar Alt +Hasta/abajo flechas para lograr esto.
4. Hecho, elimine el comentario antiguo de javadoc después de haber sido copiado en el lugar correcto.

Fuente

2015-01-30 09:28:53 mtk

_ "¿Pero qué pasa si agregué un nuevo parámetro o borré un parámetro de la firma del método. En ese caso, cómo actualizar el javadoc?" _ - La respuesta de Csaba_H resuelve esto; usted usa _Refactor_> _Método de cambio de firma ..._ y agregará y/o eliminará los param (s) tanto en la firma del método _y_ el javadoc. –

Simplemente presione ALT + SHIFT + j en el nombre del método y eliminar las líneas adicionales:

ANTES:

/** 
* Copies all the details from the passed template into the passed new 
* header. 
* 
* @param pNewHeader 
*/ 
private void doCopy(int pNewHeader, int pTemplate) {

DESPUÉS:

/** 
* Copies all the details from the passed template into the passed new 
* header. 
* 
* @param pNewHeader << DELETE 
*/     << DELETE 
/**     << DELETE 
* @param pNewHeader 
* @param pTemplate 
*/ 
private void doCopy(int pNewHeader, int pTemplate) {

Fuente

2016-02-16 14:12:01

¿Cómo puedo actualizar automáticamente el Javadoc al cambiar la firma del método en Eclipse?

Respuesta

Cuestiones relacionadas