如何在javadoc中引用方法？

Question

如何使用@link标签链接到方法？

我想要改变：

/**
 * Returns the Baz object owned by the Bar object owned by Foo owned by this.
 * A convenience method, equivalent to getFoo().getBar().getBaz()
 * @return baz
 */
public Baz fooBarBaz()

至：

/**
 * Returns the Baz object owned by the Bar object owned by Foo owned by this.
 * A convenience method, equivalent to {@link getFoo()}.{@link getBar()}.{@link getBaz()}
 * @return baz
 */
public Baz fooBarBaz()

但我不知道如何@link正确设置标签格式。

Answer 1

您可以 在标准Doclet 的
文档注释规范中 找到有关JavaDoc的许多信息，包括有关JavaDoc 的信息。

{@link
package.class＃member标签}

标签（您要查找的）。文档中的相应示例如下

例如，以下注释引用了getComponentAt（int，int）方法：

Use the {@link #getComponentAt(int, int) getComponentAt} method.

package.class如果所引用的方法在当前类中，则可以省略该部分。

关于JavaDoc的其他有用链接是：

• JavaDoc工具参考
• JavaDoc指南
• 如何为Javadoc工具编写文档注释