Question

是否有理由我更喜欢在java中编写内联注释：

/** Init operation */
mindControlLaser.engage();

而不是只使用一个*：

/* i'm a happy comment */

Eclipse以不同的方式对语法进行着色，但在使用/ ** * /时，“工具链”（javadoc，eclipse等）中是否真的有什么优势？

Answer 1

没有理由进行内联评论。

/**向javadoc实用程序发出信号，以自动提取有关API的文档。在方法内部使用它没有任何影响。

Answer 2

定期评论

/* Regular comment */

通过定期评论，您可以解释一个棘手的算法的一部分。或者您不希望成为JavaDOC一部分的任何内容。内联注释也是常规注释，例如可以在描述较短时使用。

Java文档

/** JAVA DOC COMMENT */

使用javadoc解释类，方法或字段（变量）。

然后，像Eclipse这样的大多数IDE都可以使用这些信息来帮助您进行编码。例如，如果您有classA和classB，并且在classB中使用来自classA的内容，那么如果您将鼠标悬停在方法或变量上，则可以看到JavaDOC信息。它非常方便。

此外，使用ant之类的构建工具，您可以自动从JavaDOC构建HTML文件，如果您发布它们，则可以允许其他人重复使用您的工作。查看Java本身here的文档。

Answer 3

评论的语法是/* */。

Javadoc默认使用/** */。这是一个注释，因为第二个*在注释中，因此编译器不会有不同的看法。

所以没有第二个*你只是添加一个注释，而第二个你写的是javadoc：eclipse会识别它并在你的其他地方停留在函数调用时给你提示等。

Answer 4

/** .... */将生成Javadoc，/* ... */将不生成。

当然，只有在正确的位置时才会生成Javadoc 。 Javadoc也有一个非常明确的格式，请参阅here。

Answer 5

/**表示“文档”评论;在为代码创建文档时，Javadocs等会查找这些内容。

所以它们应该只用在方法和类之上，例如：

/**
 * Class to represent tigers.
 */
class Tiger {
    /**
     * Go extinct.
     */
    void goExtinct() {
    }
}

/*变体仅表示标准注释块。

Answer 6

Javadoc对待/ **的方式不同;具有上述/ **注释的类和方法将放入javadoc输出。