java header 应该是 java 文档还是 multi-line 评论？

Question

第一个会像在 javadoc 中那样使用 /**：

/**
 * Name: Raymo111
 * Date: April 4th, 2018
 * Description: Stack overflow question about headers
 */
public class whatever {

    //Some code here

}

而第二个会像 multi-line 评论中那样使用 /*

/*
 * Name: Raymo111
 * Date: April 4th, 2018
 * Description: Stack overflow question about headers
 */
public class whatever {

    //Some code here

}

Answer 1

如果您（或某人）想要从 class 生成 Javadoc（或保留它的可能性），您将需要使用 Javadoc 注释。如果你只是想无缘无故地与众不同（或者真的讨厌 class javadoc），请使用常规注释。

当然，如果您要进行 Javadoc 注释，则应该在其中添加一些有用的内容。除了名称、日期和描述之外，您还需要提供一些关于 class、如何使用它等信息。而不是 class 的制造者和制造时间，这无关紧要。

java header 应该是 java 文档还是 multi-line 评论？

Should a java header be a javadoc or a multi-line comment?

java

comments

javadoc

multiline