usar - ¿Cómo se puede copiar el Javadoc de un método en el Javadoc de otro método?

javadoc wiki

Question

Sé que existe @inheritDoc , pero es solo para métodos que anulan a otros.

Tengo varias clases con muchos métodos de delegado (que no reemplazan a otros).

¿Se puede "heredar" su Javadoc (más exactamente: copiado)?

/** here I need the copy of wrappedMethod''s Javadoc */
public void delegateMethod(Object param){
innerSomething.wrappedMethod(param);
}

Answer 1

A veces es realmente bueno cortar y pegar documentación. La "vinculación" de la documentación de alguna manera, especialmente cuando no existe una relación de herencia, corre el riesgo de que uno de los métodos modifique su comportamiento de alguna manera, haciendo que la documentación vinculada deje de ser válida.

Sin embargo, en el caso de los delegados he tenido el mismo problema varias veces. Por lo general, tiene un método público en una clase principal que delega en un paquete privado, que tiene exactamente el mismo comportamiento que el método principal. Aquí la solución es simple: documente la clase principal y coloque @link o @see en la clase delegada. Todo el mundo puede ver la documentación de la clase principal. Es probable que también necesite tener documentación más detallada, como detalles de implementación, en la clase de delegado.

Answer 2

Una etiqueta @link o @see sería apropiada aquí. Si está envolviendo el método, debe proporcionar un comportamiento distintivo que lo haga inadecuado para la sobrecarga o de otra manera.