在eclipse中,下面两种注释有什么区别?
1. /后跟一个* /* 注释... */ 2. /后跟两个* /** 注释... */
这两种注释的颜色也不同。当我们使用第二种注释类型时,它会自动显示作者姓名。为什么是这样的呢?
1. /后跟一个* /* 注释... */ 2. /后跟两个* /** 注释... */
这两种注释的颜色也不同。当我们使用第二种注释类型时,它会自动显示作者姓名。为什么是这样的呢?
文档注释(doc comments)是指Java源代码中由
/**...*/
包围的特殊注释。这些注释将被Javadoc工具处理以生成API文档。
它们的特定格式让一些工具可以构建API文档,例如标准包所见的,同时,如果您运行它,则可生成您自己代码的API文档,使您可以正式描述参数、返回的内容等等。
当您生成文档(以HTML或其他格式)时,此文档不仅会呈现给您,还会以多种方式在IDE(如Eclipse)中展示,例如当您的鼠标悬停在某些名称上时。在javadoc中编写对于您的方法和类的用户重要的信息(而不多于有用的信息)是一个重要的良好实践。
值得一提的是,/* */
不仅用于注释掉多行内容,还可以用于注释掉if
条件中的某些内容:
if(a==b && c == d)
如果你想删除 a==b
并稍后再放回去,你不能使用 //
,因为它会将其后的整行注释掉,所以你需要这样做:
if(/*a==b &&*/ c == d)
顺便说一句,这与Eclipse无关,这是Java的一个功能。