为重载Java函数编写文档

为重载Java函数编写文档,java,android,documentation,Java,Android,Documentation,我正在为一些java方法编写自定义文档,其中一些是重载函数 我希望使文档尽可能小,易于理解。下面是函数im重载的一个例子 public void overload(String abc); public void overload(String abc, OverloadHandler handler); 有几个类似的函数,具有相同的参数,除了一个调用本身处理错误,另一个调用可以传递一个处理程序,以便调用方可以亲自处理错误(对于SDK,Android SDK,如果这很重要的话) 我怎样才能轻

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

我希望使文档尽可能小,易于理解。下面是函数im重载的一个例子

public void overload(String abc);

public void overload(String abc, OverloadHandler handler);
有几个类似的函数,具有相同的参数,除了一个调用本身处理错误,另一个调用可以传递一个处理程序,以便调用方可以亲自处理错误(对于SDK,Android SDK,如果这很重要的话)

我怎样才能轻松地证明开发人员可以在最后添加另一个参数,而不必为每个函数单独编写大量文档。类似于“此处为原始函数,如果需要,还可以在末尾添加额外的重载处理程序参数以处理错误”

所以我的问题是,这方面的最佳做法是什么

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