Java里常用的注释

1.java里注释的作用

    编写程序时为程序添加相应注释，用以说明某段代码的作用，某个类的用途，某个方法的功能，以及某个方法的参数和返回值的数据类型和意义等，便于理解和阅读。

  一般要注释的地方：

（1）类（接口）

（2）构造函数

（3）方法

（4）全局变量

（5）字段、属性

   ......

  好处：

    （1）便于自己观看和阅读代码。自己写的代码，但过了一段时间想要再次回顾或使用时，注释可以帮我们快速找到相应代码，并且帮助我们做出理解。

    （2）便于他人观看和理解自己写的代码。在现实生活中一个软件的开发往往是一个团队共同努力的结果，一个模块可能有好几个人共同完成，因此一个人写的代码要被其他人看懂，显得尤为重要，这时团队中的每个人就必须在自己写的代码中加入适当的注释，便于别人阅读和理解。

    （3）让程序有良好的可读性，减少因项目组换人带来的损失。

2.语法规则

(1)单行注释：//注释内容（用的最多）

(2) 多行注释： /* 注释内容 */ （不推荐）      

注意：多行注释“/*”、“/*”不可以嵌套。

       如果在多行注释“/*”、“/*”中嵌套了多行注释“/*”、“/*”，“/*”只会将与离它最近的“/*”之间的内容注释掉，并不能注释掉其他内容，因此有时还会产生编译错误，所以在很多情况下很不方便。

(3) 文档注释：/**文档注释*/（常用于方法和类之上描述方法和类的作用），可用于自动生成文档