3

我想为我的程序制作好的文档。函数 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-documentation 的人来说，查找每个参数的说明并不方便。为每个参数（如@param login，@param password @param rowsplitter）制作javadoc是更好的方法吗？谢谢。

4

2 回答 2

4

user1681360 回答的附录：Javadoc 旨在用于针对开发人员的文档，即您的类和接口的用户或想要修改它们的人。命令行参数的文档对整个应用程序的用户来说主要是有趣的，因此在 javadoc 中包含它是次优的。

Commons CLI（或类似的库）允许您以一种对阅读您的代码的人来说易于阅读的方式正确地记录参数，并且更重要的是 - 易于应用程序的用户阅读和访问。即由

  • --help以用户熟悉的格式提供描述所有选项的参数
  • 提供一个--help始终显示实际支持的参数集的参数，而无需您主动维护该文档
  • 确保您的参数解析大致以用户熟悉的方式运行（这意味着您需要更少的文档）
于 2013-05-08T19:35:26.887 回答
2

您可以使用 Commons CLI 之类的东西，这可以让您在记录预期输入以及最终扩展程序功能时更轻松。

http://commons.apache.org/proper/commons-cli/

于 2013-05-08T19:18:09.903 回答