小编典典

如何在 javadoc 中引用方法?

all

如何使用@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正确格式化标签。


阅读 176

收藏
2022-02-28

共1个答案

小编典典

您可以在 Standard Doclet
的文档注释规范中
找到有关 JavaDoc 的更多信息,包括有关

{@link 模块/package.class#member
标签}

标签(您正在寻找的)。文档中的相应示例如下

例如,这里有一个引用 getComponentAt(int, int) 方法的注释:

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

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


有关 JavaDoc 的其他有用链接是:

2022-02-28