Parámetro de referencia Javadoc desde otro método

Question

No quiero escribir comentarios javadoc redundantes. Como puede ver, @param x es de alguna manera redundante. ¿Hay una marca de javadoc para establecer una referencia de @param x en la clase B a @param x en la clase A o se me permite simplemente omitirla?

/** 
* Class A constructor 
* 
* @param x position on x-axis 
*/ 
public A(final int x) { 
    this.x = x; 
} 

/** 
* Class B constructor 
* 
* @param x position on x-axis 
* @param y position on y-axis 
*/ 
public B(final int x, final int y) { 
    super(x); 
    this.y = y 
} 

Answer 1

No se puede dejar fuera, javadoc no es inteligente, que sólo analiza los comentarios, no se puede decir que el parámetro para el constructor x B es la misma que la Un constructor incluso si hay es herencia en juego.

No creo que haya una manera de "factorizar" esto tampoco. Simplemente tendrá que escribirlos todos, lo siento ...

Answer 2

Con métodos debería funcionar: si sobrescribe o implementa un método, los parámetros se copian si no se proporcionan.

Los constructores no se heredan, y mucho menos a un constructor con otros tipos de parámetros. Javadoc no tiene forma de saber que pasa el parámetro a otro constructor, ya que no interpreta los contenidos de los métodos/constructores, solo la interfaz externa.

Entonces, supongo que no tiene suerte, si no quiere escribir su propio documento o cambiar el documento estándar (e incluso entonces tendría que decir de alguna manera de qué constructor heredar los parámetros). (Esta sería una adición útil, también para métodos similares múltiples en la misma clase, creo).

Answer 3

Si está anulando un método principal, si no incluye el javadoc, la mayoría de los IDEs mostrarán el javadoc para el método principal en su lugar. De lo contrario, no hay forma de definir/referir a variables en la sintaxis javadoc.