java - 如何在 Java main 中记录参数

标签 java javadoc

您如何记录 args 的内容?参数在:

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

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

例如:“args[1] 是宽度,args[2] 是高度,等等”。

<ol><li></li></ol>怎么走?

最佳答案

您只能以非正式的方式做到这一点,方法是在您的 javadoc 中写下一些描述预期参数的文本。

意思是:这里没有单一的、正确的方法。

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

如果您的“团队风格指南”允许(要求?)您在 javadoc 中使用 HTML 标签,那么请使用 HTML 标签。如果您的团队有一些更复杂的方法允许某种markdown 语言,那么就使用它。否则,您可能应该只使用 {@code} 来突出显示某些部分。

长话短说:这里没有确切的规则;所以您应该选择最适合您需求的东西

但请记住:也许 javadoc 最后没那么重要。如果您认为您的应用程序是直接从命令行使用的,那么您的主要关注点应该是“java -jar yourjar --help”之类的东西提供合理的输出。并且您不会在“参数”解析方面重新发明轮子。换句话说:有很多库可以用于命令行解析。而且我很确定他们应该支持记录命令行用户的潜在参数。

我的意思是:在“正常”设置中,我希望那些对调用您的主要方法感兴趣的人不会阅读 javadoc。他们想查看一些帮助屏幕以了解他们可以使用哪些选项!

关于java - 如何在 Java main 中记录参数,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/40338921/

相关文章:

Java:数组扩展并没有改变原始数组?

java - 保持 Java 程序无限期运行的有效方法?

来自另一个方法的 Javadoc 引用参数

java - 管理 javadoc 以使用 jdk 1.7

java - 使用java向keycloak用户添加客户端角色

java - mockito 对带参数的方法不做任何贡献

java - 无法从 Java 中的 cookie 获取值。值包含逗号。

java - IntelliJ 不加载 JavaDoc

java - 如何修复 Eclipse 生成空的 Javadoc 注释?

Maven:如何从 javadoc 中排除特定的源文件?