Javadoc: link 使用默认参数的方法

Question

我有两种方法，其中一种方法是另一种方法的简单代理，带有一些默认参数：

/**
 * do the foo
 * @param bar preprocess object baz
 * @param baz the object we are working on
 */
public void foo(boolean bar, Object baz) {}

/**
 * do the foo, with preprocessing.
 * See {@link #foo(boolean, Object)}
 * @param baz the object we are working on
 */
public void foo(Object baz) {
    foo(true, baz);
}

此处，第二种方法 foo(Object) 是 *foo('true', Object) 的便捷快捷方式。

Q: 我如何在 javadoc 中说明这一点？我的意思是用 {@link #foo(true, Object) 之类的东西替换“See {@link #foo(boolean, Object)}”？（然而，后一个版本在语法上是不正确的。）

Answer 1

@link 构造允许您显示任意文本，同时仍然链接到正确的 Java 元素：

/**
 * do the foo, with preprocessing.
 * See {@link #foo(boolean, Object) foo(true, Object)}
 * @param baz the object we are working on
 */
public void foo(Object baz) {
    foo(true, baz);
}

Javadoc: link 使用默认参数的方法

Javadoc: link to method with default argument

javadoc