如何在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

您可以在 Documentation Comment Specification for the Standard Doclet 找到有关JavaDoc的更多信息，包括有关

的信息

  

<强> {@link package.class#member label}

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

  

例如，这是一个引用getComponentAt（int，int）方法的注释：

     

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

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

---

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

• JavaDoc Tool Reference
• JavaDoc Guide
• How to Write Doc Comments for the Javadoc Tool

Answer 2

@link section of the javadoc documentation的一般格式为：

实施例

同一课程中的方法：

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

Answer 3

您可以使用@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();
    }