Question

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

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

/**
 * 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的目标受众是开发人员，而不是您的应用程序用户。因此，在Javadocs中记录参数的确切细节是没有意义的。相反，如果消息传递了错误或缺少的参数，请考虑将消息打印出来。要获得更全面的解决方案，您还可以考虑使用Apache Commons CLI等库。

Answer 2

您如何看待这条评论：

/**
 * The main method is where the Apple are created.
 * @param   apple the original Apple 
 * @param   firstInput some definition
 * @param   secondInput some definition
 * @param args supplies command-line arguments as an array of String objects
 */
 public static void main (String args[]) {

Java中main方法中args的jdoc描述

2 个答案: