来自另一个方法的 Javadoc 引用参数

标签 java javadoc

我不想写多余的 javadoc 注释。如您所见,@param x 在某种程度上是多余的。是否有 javadoc 标记来设置从 B 类中的 @param xA 类中的 @param x 的引用> 或者我可以忽略它吗?

/**
 * 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
}

最佳答案

你不能漏掉它,javadoc 不聪明,它只是解析注释,他不能说 B 构造函数的 x 参数即使存在继承,也与 A 构造函数相同。

我认为也没有办法“分解”它。你只需要写下所有这些,抱歉......

关于来自另一个方法的 Javadoc 引用参数,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/5252122/

相关文章:

java - 如何从java中的字符串中删除>标签

android - 如何在没有绝对路径的情况下将本地 javadoc 文件夹附加到项目

gradle - Gradle Javadoc多行选项不起作用

java - 我应该在 javadoc 中写多个 @return 标签吗

java - Maven、Subversion、Javadocs

linux - Eclipse Javadoc 没有正确显示 HTML 表格

java - Jackson/Scala 不可变案例类 : parsing a class depending on other value in JSON

java - 为具有多种数据类型的 Java 对象建模的最佳方法

java - 使用stream()collect()groupingBy()和reducing()的多级映射

Java:使用 Axis2 stub 类调用 Web 服务