用于显示另一种方法的doc的Javadoc标记

时间:2017-04-05 15:55:14

标签: java javadoc

是否有用于显示另一种方法的doc的javadoc标记?这些方法只是简单地将调用转发给其他类'方法。我寻找的不仅仅是@see。感谢。

2 个答案:

答案 0 :(得分:1)

如果您使用{@link MyClass#myMethod(String, etc.)},工具提示会显示为可点击,点击后会显示myMethod的JavaDoc。您还可以在}之前添加说明。

答案 1 :(得分:1)

没有任何机制可以包含任意方法的文档。

但是,您可以从最近的超类或接口中声明的相同方法继承文档,方法注释中的using the tag {@inheritDoc}和/或@param,@ return和@抛出标签。

例如:

public class Foo {
  /** Implements the equals method for Foo objects.
   *  <p>Follows the contract specified by {@link java.lang.Object#equals(Object)}:</p>
   *
   * {@inheritDoc}
   *
   * @param obj {@inheritDoc}
   * @return {@inheritDoc}
   */
  public boolean equals(Object obj) {
     ...
  }
  ...
}