注释/ * * /和/ ** * /之间的区别?

时间:2013-08-08 11:16:27

标签: java eclipse

eclipse中以下评论之间有什么区别:

  1. /后跟一个*

    / * 评论... * /

  2. /后跟两个**

    / ** 评论... * /

  3. 两条评论的颜色也不同。当我们使用2 nd 类型注释时,它将自动显示@author名称。为什么会这样?

2 个答案:

答案 0 :(得分:10)

/** */条评论为javadoc条评论,更多详情here

  

文档评论(文档评论)

     

Java中的特殊注释   由/ ** ... * /分隔符分隔的源代码。这些   评论由Javadoc工具处理以生成API文档。

他们的特定格式允许一些工具构建API文档,如the one you see of the standard package,但如果运行它,也可以构建自己的代码。它允许您以正式的方式描述参数,返回的内容等。

生成它时不仅会向您呈现此文档(作为HTML或其他格式),它还会以多种方式呈现在IDE中,例如Eclipse,例如当鼠标悬停某些名称时。在javadoc中编写方法和类的用户所需的重要信息(并且不超过有用的信息)是一个重要的良好实践。


值得一提的是,/* */不仅可用于评论多行。考虑一种情况,当您想在if条件中注释掉某些内容时:

if(a==b && c == d)

然后,如果您要删除a==b并稍后将其放回,则无法使用//,因为它会在其后面注释掉整行,所以您这样做:

if(/*a==b &&*/ c == d)

顺便说一下,这与Eclipse无关,这是一个Java特性。

答案 1 :(得分:0)

第一个是多行评论。

第二个@author标记为JavaDoc