java 标头应该是 javadoc 还是多行注释？

Posted 2023-02-21

【中文标题】java 标头应该是 javadoc 还是多行注释？

【英文标题】：Should a java header be a javadoc or a multi-line comment?

【发布时间】：2018-09-14 07:42:11

【问题描述】：

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

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

    //Some code here

---

第二个会在多行注释中使用/*

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

    //Some code here

【问题讨论】：

在 Java 中，您几乎总是需要 Java 文档，那么为什么不直接使用它呢？

如果你想使用 javadoc，请使用 @author 等 javadoc 标签。

【参考方案1】：

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

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

【讨论】：

我的老师希望我们使用带有名称、日期和描述的标题。这就是为什么我要问是使用 javadoc 还是多行注释。如果我将相关的类内容放在标题中，我显然会使用 javdoc。

那没关系。如果您愿意，您可以添加// 行。问你的老师他们想要什么样的cmets。不要把cmets的类型当成问题，那是在浪费时间。