代码之家 › 专栏 › 技术社区 › drJava

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

javadoc java

drJava · 技术社区 · 8 年前

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

以下结果为:;

1 回复 | 直到 8 年前

VGR 8 年前

没有办法将一个项目javadoc复制到另一个项目中,除了 {@inheritDoc} 只能从同一项的超类文档中插入。

构造函数设置私有int字段是内部实现的一部分。您的javadoc不应提及,或者 {@link}

私有javadoc通常与公共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;

推荐文章

Stephen.lin · 当鼠标向上移动弹出java文档时,IntelliJ思想如何像eclipse一样工作

8 年前

Vulkanos · 我可以在自定义doclet的帮助下生成Javadoc注释吗?

8 年前

Fraquack · Kotlin-接口方法引发的文档异常

8 年前

Adrien Aacha · Javadocs-@param name未找到

8 年前

Mohan · 为具有(模拟的)可选/默认参数的函数编写Javadoc

8 年前

Jai · vararg方法的Javadoc链接

8 年前

grandouassou · 使用Java Bean验证注释从POJO生成文档

8 年前

drJava · 在JavaDoc中将方法参数与类成员链接

8 年前

Batman · Javadoc和继承的类

10 年前

CrypticStorm · IntelliJ Javadoc每行增加一个星号

11 年前