String[] args 的 javadoc

Question

我希望为我的程序制作良好的文档。主函数从命令行接收参数：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文档的人而言，为每个参数查找说明并不方便。是否最好为每个参数创建Javadoc（如@param login、@param password、@param rowsplitter）？谢谢。

- Olia Pavliuk

Answer 1

对于用户1681360的答案的补充：Javadoc旨在为开发人员提供文档，即提供给使用您的类和接口或想要修改它们的人。命令行参数的文档主要对应用程序的用户感兴趣，因此将其放在javadoc中并不是最佳选择。

Commons CLI（或类似库）允许您以一种易于阅读的方式正确记录参数，以便代码阅读者和更重要的是应用程序的用户都能轻松阅读和访问。具体方法为：

• 提供 --help 参数，以格式描述所有选项，这是用户熟悉的格式
• 提供一个 --help 参数，始终显示支持的实际参数集，而无需您积极维护该文档
• 确保您的参数解析大致按照用户熟悉的方式运作（这意味着您需要较少的文档）

- creinig

Answer 2

你可以使用像Commons CLI这样的工具，它能使输入的文档化和程序功能扩展更加简单。 http://commons.apache.org/proper/commons-cli/

- Elmer