我正在为一些 java 方法编写自定义文档，其中一些是重载函数。
我希望文档尽可能小且易于理解。这是函数重载的示例。
public void overload(String abc);
public void overload(String abc, OverloadHandler handler);
有几个这样的函数，它们具有相同的参数，但事实上，一个调用本身处理错误，另一个可以传递一个处理程序，以便调用者可以亲自处理错误(对于 SDK，Android SDK，如果是这样的话)事项)。
我如何轻松地表明开发人员可以在最后添加另一个参数，但不必为每个函数单独提供大量文档。类似于“这里的原始函数，如果需要，您也可以在末尾添加一个额外的 OverloadHandler 参数来处理错误”
所以我的问题是，最佳实践是什么？
最佳答案
尝试
/** This function forwards to {@link #overload(String,OverloadHandler) overload}
* with a default handler.
*/
关于java - 为重载的 Java 函数编写文档，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/8304423/