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?Parámetro de referencia Javadoc desde otro método
/**
* 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
}
Me gustaría dar un paso atrás y preguntar por qué está documentando parámetros que parecen tener un significado obvio. Si el código es autodocumentado según los nombres que elija, JavaDoc es en gran medida irrelevante. –
@John Este es un ejemplo mínimo, solo para ilustración. – Matthias
Nota para mí: [{@inheritDoc}] (http://docs.oracle.com/javase/1.4.2/docs/tooldocs/windows/javadoc.html#inheritingcomments) al menos permite copiar un documento de un método reemplazado . – Matthias