javadoc for String [] args

时间:2013-05-08 19:01:44

标签: javadoc main

我想为我的程序制作好的文档。 函数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文档的人来说,找到每个参数的描述是不方便的。 是为每个参数创建javadoc的更好方法(如@param login,@ param password @param rowsplitter)? 感谢。

2 个答案:

答案 0 :(得分:4)

对user1681360答案的补充:Javadoc旨在用于针对开发人员的文档,即您的类和接口的用户或想要修改它们的人。命令行参数的文档主要是对应用程序的用户感兴趣,因此在javadoc中使用它是次优的。

Commons CLI(或类似的lib)允许您正确地记录参数,以便读取代码的人易于阅读,更重要的是 - 应用程序的用户易于阅读和访问。即由

  • 提供--help参数,以用户熟悉的格式描述所有选项
  • 提供--help参数,该参数始终显示实际支持的参数集,而无需您主动维护该文档
  • 确保您的参数解析粗略地以用户熟悉的方式运行(意味着您需要更少的文档)

答案 1 :(得分:2)

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

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