java - Java中main方法中args的Jdoc描述

Question

我正在 main 方法上方创建 Jdoc 注释。

在这种情况下，参数的正确描述是什么？

/**
 * supplies command-line arguments as an array of String objects
 * @param args 
 */
public static void main (String args[]) {

    Apple apple = new Apple();
    String firstInput = JOptionPane.showInputDialog("Enter number of apples: ");
    apple.setNumber(Double.parseDouble(firstInput));

    String secondInput = JOptionPane.showInputDialog("Enter apple type: ");
    apple.setType(Double.parseDouble(secondInput));

    JOptionPane.showMessageDialog(null, apple.toString());

}

非常感谢您查看我的问题。

Answer 1

主应用程序入口点通常不需要文档，因为它是 Java 应用程序的常见且易于理解的方法。 Even Oracle's "Hello World" example doesn't bother to document it 。

但是，如果您仍然倾向于记录主要方法签名，也许像下面这样就足够了:

/**
 * The application's entry point
 *
 * @param args an array of command-line arguments for the application
 */
public static void main(String[] args) {
    ...
}

请记住，Javadocs 的目标受众是开发人员，而不是应用程序用户。因此，在 Javadoc 中记录参数的确切细节没有什么意义。相反，如果用户传递了不正确或丢失的参数，请考虑向用户打印消息。对于更全面的解决方案，您还可以考虑像 Apache Commons CLI 这样的库.