Java中的内联注释:/**与/*相对？

Question

有什么理由我更喜欢在java中编写内联注释,如下所示:

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

而不是只使用一个*:

/* i'm a happy comment */

Eclipse以不同的方式对语法进行着色,但是在使用/***/时,"工具链"(javadoc,eclipse等)中是否真的有任何优势？

Answer 1

没有理由进行内联评论.

/**向javadoc实用程序发出信号,以自动提取有关API的文档.在方法内部使用时没有任何效果.

Answer 2

定期评论

/* Regular comment */

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

/** JAVA DOC COMMENT */

使用javadoc,您可以解释类,方法或字段(变量).

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

此外,使用类似的构建工具ant可以自动从JavaDOC构建HTML文件,如果您发布它们,则可以允许其他人重用您的工作.在这里查看 Java本身的文档.