我想为我的程序做一个好的文档。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 login， @param password @param rowsplitter)制作javadoc是更好的方法吗?谢谢。
对user1681360的回答的补充:Javadoc是针对开发人员的文档，即您的类和接口的用户或想要修改它们的人。命令行参数的文档主要是对应用程序的用户感兴趣的，因此将其放在javadoc中是次优的。
Commons CLI(或类似的库)允许您以一种既便于阅读代码的人阅读，更重要的是便于应用程序用户阅读和访问的方式正确地记录参数。即通过
- 提供
--help参数，以用户熟悉的格式描述所有选项 - 提供一个
--help参数，该参数始终显示实际的支持的参数集，而无需您主动维护该文档 - 确保您的参数解析大致以用户熟悉的方式运行(意味着您需要更少的文档)
你可以使用像Commons CLI这样的东西，这让你在记录预期的输入和最终扩展你的程序的功能时更容易。
http://commons.apache.org/proper/commons-cli/