java - 在 JavaDoc 中将方法参数与类成员链接

Question

在我们公司，有一条严格的规定，一切都必须评论。该规则有一些弱点，例如重复文本。为了避免重复注释，我想将方法​​参数引用到类成员，但找不到正确的解决方案。

当我链接方法参数中的类成员并将鼠标悬停在方法参数上时，

  /**
   * I would like to see this comment
   */
  private int       lineNumber;

  /**
   * Creates a new {@link GroupByMetaData} object.
   *
   * @param aLineNumber {@link GroupByMetaData#lineNumber}
   */
  public GroupByMetaData( int aLineNumber )
  {
    super();
    this.lineNumber = aLineNumber;
  }

以下结果是；

实现这一目标的正确方法是什么？

Answer 1

没有办法将一个项目的 javadoc 复制到另一个项目中，除了 {@inheritDoc} ，它只能从同一项目的父类(super class)文档插入。

构造函数设置私有(private) int 字段的事实是内部实现的一部分。您的 javadoc 不应提及或 {@link} 私有(private)字段；相反，javadoc 应该从概念上描述它。

私有(private) javadoc 通常与公共(public) javadoc 不同。私有(private) javadoc 将包含该类的一般用户不应该看到的重要实现细节。例如:

/**
 * Line of input this object will analyze.  This is never negative.
 * Controls the loops in the `read` method and the `translate` method.
 */
private int lineNumber;