如何在Java main中记录args

Question

你如何记录args参数的内容:

public static void main(String[] args) {
    ...
}

我不是在询问如何@param在javadoc中使用块标记,而是如何记录数组中每个项目的内容应该是什么.

例如:"args [1]是宽度,args [2]是高度等".

是<ol><li></li></ol>要走的路？

Answer 1

您只能通过在javadoc中写下描述预期参数的一些文本,以非正式方式执行此操作.

含义:这里没有单一,正确的方法.

换句话说:您应该使用最适合您的选项,以及团队/项目中的其他人.

如果您的"团队风格指南"允许(询问？)您在javadoc中使用HTML标记,那么请使用HTML标记.如果您的团队有一些更复杂的方法允许某种降价语言,那么使用它.否则,您可能只应使用{@code}突出显示某些部分.

长话短说:这里没有确切的规则; 所以你应该最适合你的需求.

但要记住:也许javadoc的是不那么重要的结束.如果您认为您的应用程序是直接从命令行使用的,那么您的主要焦点应该是"java -jar yourjar --help"之类的内容可以提供合理的输出.并且你不会在"论证"解析方面重新发明轮子.换句话说:有很多库可用于命令行解析.我非常确定他们应该支持记录命令行用户的潜在参数.

我所说的是:在"正常"设置中,我希望那些对调用main方法感兴趣的人不会读取javadoc.他们想看看一些帮助屏幕,了解他们可以使用哪些选项!