为重载的Java函数编写Docs

Question

我正在为一些java方法编写自定义文档，其中一些是重载函数。

我希望尽可能简化文档并使其易于理解。下面是一个重载函数的例子。

public void overload(String abc);

public void overload(String abc, OverloadHandler handler);

有这样的几个函数，具有相同的参数，禁止一个调用本身处理错误，另一个可以传递一个处理程序，以便调用者可以亲自处理错误（对于SDK，Android SDK，如果有的话）事项）。

我如何轻松地展示开发人员可以在最后添加另一个参数，但不必单独为每个功能提供大量文档。这里有一些“原始函数，你也可以在最后添加一个额外的OverloadHandler参数来处理错误，如果你想要的话”

所以我的问题是，最好的做法是什么？

Answer 1

尝试

/** This function forwards to {@link #overload(String,OverloadHandler) overload} 
 *  with a default handler.
 */