为重载的 Java 函数编写文档
我正在为一些 java 方法编写自定义文档，其中一些是重载函数。
我想让文档尽可能小且易于理解。这是函数重载的示例。
public void overload(String abc);
public void overload(String abc, OverloadHandler handler);
有几个这样的函数，它们具有相同的参数，但事实上，一个调用本身处理错误，另一个可以传递一个处理程序，以便调用者可以亲自处理错误（如果重要的话，它适用于 SDK、Android SDK）。
我如何轻松地表明开发人员可以在最后添加另一个参数，但不必为每个函数单独提供大量文档。类似于“这里的原始函数，如果需要，您也可以在末尾添加一个额外的 OverloadHandler 参数来处理错误”
所以我的问题是，最好的做法是什么？
Im writing custom docs for some java methods, and some of them are overloaded functions.
I want to make the documentation as small and easy to understand as possible. Heres an example of the functions im overloading.
public void overload(String abc);
public void overload(String abc, OverloadHandler handler);
There are several functions like this, with identical parameters, bar the fact that one call handles errors itself, and the other can be passed a handler so the caller can handle the errors personally (its for an SDK, Android SDK if that matters).
How can i easily show that a developer can add another parameter on the end, but not have to have a massive piece of documentation for each function individually. Something along the lines of "original function here, also you can add an extra OverloadHandler parameter to the end to handle errors if you want"
So my question is, whats the best practice for this?
如果你对这篇内容有疑问，欢迎到本站社区发帖提问 参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱，如果其他用户或者作者回复了您的评论，将不能在第一时间通知您！
发布评论
评论（1）
尝试
Try