String[] 参数的 javadoc

Question

我想为我的程序制作好的文档。main 函数从命令行接收参数:LOGIN、PASSWORD 等(共有 9 个参数)。

/**
* Command-line interface.   
* @param args LOGIN - login of user PASSWORD - password, row splitter - symbol after each row in text file
*/
public static void main(String[] args){

}

但是对于阅读 html 文档的人来说，找到每个参数的说明并不方便。为每个参数(如@param 登录、@param 密码、@param rowsplitter)制作 javadoc 是更好的方法吗？谢谢。

Answer 1

user1681360 的回答的附录:Javadoc 旨在用于针对开发人员 的文档，即您的类和接口(interface)的用户或想要修改它们的人。命令行参数的文档主要对整个应用程序 的用户感兴趣，因此将其放在 javadoc 中并不是最佳选择。

Commons CLI(或类似的库)允许您正确记录参数，使阅读您的代码的人易于阅读，更重要的是，应用程序的用户易于阅读和访问。即由

• 提供一个--help参数，以用户熟悉的格式描述所有选项
• 提供一个 --help 参数，该参数始终显示实际 受支持参数集，您无需主动维护该文档
• 确保您的参数解析大致以用户熟悉的方式进行(这意味着您需要更少的文档)