我不想写冗余的javadoc注释。如您所见,@param x
在某种程度上是多余的。是否有一个javadoc标记用于在@param x
课程B
中设置@param x
到A
/**
* 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
}
的引用,或者我可以将其删除?
{{1}}
答案 0 :(得分:3)
你不能遗漏它,javadoc
不聪明,它只是解析注释,他不能说B构造函数的x
参数与A相同构造函数,即使在游戏中有继承。
我认为没有办法“分解”这一点。你只需要写下所有这些,抱歉......
答案 1 :(得分:1)
使用方法时它应该有效:如果覆盖或实现方法,则在未提供参数的情况下复制参数。
构造函数不是继承的,更不用于具有其他参数类型的构造函数。 Javadoc无法知道您将参数传递给另一个构造函数,因为它不解释方法/构造函数的内容,只解释外部接口。
所以,如果您不想编写自己的doclet或更改标准doclet,我认为您运气不好(即使这样,您也必须以某种方式说明从哪个构造函数继承params)。 (这对于同一类中的多个类似方法也是一个有用的补充,我认为。)
答案 2 :(得分:1)
如果要覆盖父方法,如果不包含javadoc,则大多数IDE将显示父方法的javadoc。否则,无法在javadoc语法中定义/引用变量。