Class 和 Main 方法的 JavaDoc 有何不同？

Question

简单的例子：

假设我有一个类，其中包含一个

minValue

方法、一个

maxValue

方法和一个

averageValue

方法，每个方法都采用双数组，还有 Main 方法。

假设还在 main 方法中，我定义了一个双精度数组，然后使用上述方法打印其最小值、最大值和平均值。

Class 和 Main 方法的 Javadoc 应该是什么？

我对 Java 很陌生，我总是发现 main 方法 Javadoc 只是重申了类 Javadoc，声明它似乎毫无意义。

例如

/**This class can be used to find the min, max and average value of an array

Main method: calculates the min, max and average value of an array*/

这是正确的吗？还是有更好的方法来区分 Class 和 Main 方法 Javadoc？

Answer 1

我不会为

main

方法添加 java 文档

除了一个小描述之外，您还应该以此格式为每个方法添加参数和返回类型 https://www.jetbrains.com/help/idea/javadocs.html#add-new-comment

Answer 2

main方法只是应用程序的入口点。它与业务逻辑无关。如果您想将 javadoc 添加到您的 main 方法中，请描述如何启动应用程序。将主方法中的所有内容都写成应用程序应该执行的操作是一个常见的错误。将您的任务分离到类和方法上，并实例化执行实际工作的对象。

另请注意，您必须为每个

public

方法添加javadoc。其他附件是可选的，但向它们添加 javadoc 以便更好地了解您的应用程序在做什么也不错。