类和主方法的 Java 文档应该有何不同？

Question

简单的例子：

假设我有一个类，其中包含一个 minValue 方法、一个 maxValue 方法和一个 AverageValue 方法，每个方法都采用双精度数组，并且还包含 Main 方法。

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

类和主要方法的 Javadoc 应该是什么？

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

例如

“此类可用于查找数组的最小值、最大值和平均值”

“主要方法：计算数组的最小值、最大值和平均值”

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

Answer 1

我不会为

main

方法添加 java 文档

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