将方法参数与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}，它只能从同一项目的超类文档中插入。

构造函数设置私有int字段的事实是内部实现的一部分。你的javadoc不应该提及私人领域，或{@link}私人领域;相反，javadoc应该在概念上描述它。

私有javadoc通常与public javadoc不同。私有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;