eclipse中的以下评论有什么区别:
/ 后跟一个 *
/* 注释... */
/ 后跟两个 **
/** 注释... */
两条评论的颜色也不同。当我们使用第二种类型的注释时,它会自动显示@author
名称。为什么会这样?
文档注释(文档注释)
Java 源代码中由 /** ... */ 分隔符分隔的特殊注释。这些注释由 Javadoc 工具处理以生成 API 文档。
它们的特定格式允许一些工具构建 API 文档,就像您看到的标准包一样,但如果您运行它,也可以构建您自己的代码。它允许您以正式的方式描述参数、返回的内容等。
该文档不仅会在您生成它时呈现给您(作为 HTML 或其他格式),它还会在 IDE(如 Eclipse)中以多种方式呈现,例如当您的鼠标悬停在某些名称上时。在 javadoc 中编写方法和类的用户所需的重要信息是一个重要的好习惯(仅是有用的信息)。
值得一提的/* */
是,这不仅对注释多行有用。考虑一种情况,当您想注释掉条件中的某些内容if
时:
if(a==b && c == d)
然后,如果您想a==b
稍后将其删除并放回原处,则不能使用//
,因为它会注释掉之后的整行,因此您可以:
if(/*a==b &&*/ c == d)
顺便说一句,这与 Eclipse 无关,这是 Java 特性。
第一个是多行注释。
第二个,带有@author
一个这样的标签,称为JavaDoc。