用于显示另一种方法的文档的 Javadoc 标签

Question

是否有一个 javadoc 标签用于显示另一种方法的文档？这些方法只是将调用中继到其他类的方法。我正在寻找的不仅仅是@see。谢谢。

Answer 1

如果使用{@link MyClass#myMethod(String, etc.)}，工具提示将显示为可单击，并且单击时将显示 的 JavaDoc myMethod。您还可以在 之前添加描述}。

Answer 2

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

但是，您可以使用方法注释中的标记 {@inheritDoc}和/或 @param、@return 和 @throws 标记，从最近的超类或接口中声明的相同方法继承文档。

例如：

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) {
     ...
  }
  ...
}