2.1　代码注释

视频讲解：资源包\Video\02\2.1代码注释.mp4

在代码中添加注释能提高代码的可读性。注释中包含了程序的信息，可以帮助程序员更好地阅读和理解程序。在Java源程序文件的任意位置都可以添加注释，且Java编译器不编译代码中的注释，也就是说代码中的注释对程序不产生任何影响。所以开发者不仅可以在注释中键入代码的说明文字、设计者的个人信息，还可以使用注释来屏蔽某些不希望执行的代码。Java提供了3种代码注释，分别为单行注释、多行注释和文档注释，这些注释在Eclipse中的效果如图2.1所示。

图2.1　在Eclipse中给代码添加注释的效果

1.单行注释

//为单行注释标记，从符号//开始直到换行为止的所有内容均作为注释而被编译器忽略。语法如下：

例如，以下代码为声明int型变量添加注释：

2.多行注释

/**/为多行注释标记，符号/*与*/之间的所有内容均为注释内容。注释中的内容可以换行。语法如下：

3.文档注释

/**…*/为文档注释标记。符号/**与*/之间的内容均为文档注释内容。当文档注释出现在声明（如类的声明、类的成员变量声明、类的成员方法声明等）之前时，会被Javadoc文档工具读取作为Javadoc文档内容。对于读者而言，文档注释并不是很重要，了解即可。

说明

一定要养成良好的编码习惯。软件编码规范中提到“可读性第一，效率第二”，所以程序员必须要在程序中添加适量的注释来提高程序的可读性和可维护性。建议程序中的注释总量要占程序代码总量的20%～50%。