【Java个人笔记】注释

一、什么是注释？

注释简单的来说就是一种说明，不能被当成执行语句执行。
注释用来说明某段代码的作用，或者说明某个类的用途，每个方法的功能，以及该方法的参数和返回值的数据类型及意义等。

二、为什么要添加注释？

1，永远不要过于相信自己的理解力。为了过段时间还能简单明了的看懂自己的以前的代码，建议添加注释。
2，可读性第一，效率第二。团队协同开发中，团队成员的沟通比较重要，为了自己写的代码能被整个团队理解，建议添加注释。
3，代码即文档。自己平时写一些代码，为了生成一些规范的文档，建议添加注释。

 

三、注释分类

注释共有3种，可根据需要选择：
1、单行注释  \\
在每行后面注释时加上\\，注释内容从\\开始到本行结尾；
在eclipse中，单行注释的快捷键是control+/或control+shift+c，按一次是添加注释，在按一次就是取消注释。
2、多行注释  \*     *\
注释内容从\*开始到*\终止，中间可出现多行。
在eclipse中，多行注释的快捷键是command+control+/，选择注释代码，按下command+control+/，代码前后会出现\*     *\，按下command+control+\取消注释。
3、文档注释  \**     *\
以“/**”开头，以“*/”结尾。文档注释主要是生成文档的。

 

 

四、注释的选择

1. 总注释（整个代码的思路，类之间的关系）
2. 具体类功能注释 
3. 类变量注释
4. 类方法注释

 

 

5. 类方法中代码块注释

 

 

后续补充

1、\u不能出现在注释中