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

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

{@link package.class＃member标签}

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

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

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

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

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

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

来自javadoc文档的@link部分的常规格式为：

例子

同一类中的方法：

/** See also {@link #myMethod(String)}. */
void foo() { ... }

在相同的包中或导入的不同类中的方法：

/** See also {@link MyOtherClass#myMethod(String)}. */
void foo() { ... }

方法在其他包中且未导入：

/** See also {@link com.mypackage.YetAnotherClass#myMethod(String)}. */
void foo() { ... }

以纯文本而不是代码字体链接到方法的标签：

/** See also this {@linkplain #myMethod(String) implementation}. */
void foo() { ... }

一连串的方法调用，就像您的问题一样。我们必须为此类之外的方法的链接指定标签，否则我们将得到getFoo().Foo.getBar().Bar.getBaz()。但是这些标签可能很脆弱。请参阅下面的“标签”。

/**
 * A convenience method, equivalent to 
 * {@link #getFoo()}.{@link Foo#getBar() getBar()}.{@link Bar#getBaz() getBaz()}.
 * @return baz
 */
public Baz fooBarBaz()

标签

自动重构可能不会影响标签。这包括重命名方法，类或包；并更改方法签名。

因此，仅在需要与默认文本不同的文本时才提供标签。

例如，您可能从人类语言链接到代码：

/** You can also {@linkplain #getFoo() get the current foo}. */
void setFoo( Foo foo ) { ... }

或者，您可以从代码示例中链接其文本与默认文本不同的文本，如上面“方法调用链”下所示。但是，随着API的发展，这可能很脆弱。

类型擦除和#member

如果方法签名包括参数化类型，请在javadoc @link中使用这些类型的擦除。例如：

int bar( Collection<Integer> receiver ) { ... }

/** See also {@link #bar(Collection)}. */
void foo() { ... }

您可以@see用来做到这一点：

样品：

interface View {
        /**
         * @return true: have read contact and call log permissions, else otherwise
         * @see #requestReadContactAndCallLogPermissions()
         */
        boolean haveReadContactAndCallLogPermissions();

        /**
         * if not have permissions, request to user for allow
         * @see #haveReadContactAndCallLogPermissions()
         */
        void requestReadContactAndCallLogPermissions();
    }