提问人：Gabi23 提问时间：11/3/2023 最后编辑：Roman CGabi23 更新时间：11/3/2023 访问量：68
Class 和 Main 方法的 JavaDoc 应该有何不同？
How should the JavaDoc for Class and Main method differ?
问：
简单示例：
假设我有一个类，其中包含一个方法、一个方法和一个方法，每个方法都采用一个双精度数组，以及 Main 方法。minValuemaxValueaverageValue
假设同样在 main 方法中，我定义了一个双精度数组，然后使用上述方法打印其最小值、最大值和平均值。
Class 和 Main 方法的 Javadoc 应该是什么？
我是 Java 的新手，我总是发现 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？
答：
0赞
Nikos Issaris
11/3/2023
#1
我不会为该方法添加 java 文档main
此外，除了简短的描述之外，您还应该以这种格式为每个方法添加参数和返回类型 https://www.jetbrains.com/help/idea/javadocs.html#add-new-comment
0赞
Reilas
11/3/2023
#2
"...这是正确的，还是有更好的方法来区分 Class 和 Main 方法 Javadoc？
没有正确或不正确的方法，只有建议。
通常，main 方法应包含最少量的代码。
我的建议是将您当前的代码放在一个单独的方法中，并从 main 调用它。
记录此方法可能更易于管理。
public static void main(String[] args) {
Example example = new Example();
example.abc();
}
void abc() {
}
评论
mainmain()