### 代码注释

通过在程序代码中添加注释可提高程序的可读性。在 Java 源程序文件的任意位置都可添加注释语句。注释中的文字 Java 编译器并不进行编译，所有代码中的注释文字并不对程序产生任何影响。Java 语言提供了 3 种添加注释的方法。分别为：单行注释、多行注释和文档注释。

#### 1．单行注释

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

语法如下：

//注释内容

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

int age ; //定义 int 型变量用于保存年龄信息

#### 2．多行注释

“/* */”为多行注释标记，符号“/*”与“*/”之间的所有内容均为注释内容。注释当中的内容可以换行。

语法如下：

/*

注释内容 1

注释内容 2

…

*/

注意：在多行注释当中可嵌套单行注释。例如:

/*

程序名称：Hello word //开发时间:2008-03-05

*/

但在多行注释中不可以嵌套多行注释，例如以下代码为非法代码。

/*

程序名称：Hello word

/*开发时间:2008-03-05

作者：张先生

*/

*/

#### 3．文档注释

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

例如，为 First 类的主方法添加文档注释的关键代码如下：

/**

* 这是 First 类的主方法，它将输出成员变量 s1 和局部变量 s2 的连接字符串。

*

* @param args

* 主方法的入口参数，用于接收命令行参数

*/

public static void main(String[] args) { // 主方法

String s1 = "明日科技";// 局部变量

String s2 = "主类的结构"; // 局部变量

System.out.print(s1); // 输出变量 s1

System.out.println(s2); // 输出变量 s2

}

添加了文档注释的类成员，会在 Eclipse 的“JavaDoc”视图中显示相应的说明，另外，在编辑器中，把鼠标停留在该方法或引用该方法的位置上，也会出现悬浮提示信息。如图 1 所示。

图 1 类成员文档注释信息

技巧：在Java源文件编辑器中，选择某个成员方法或成员变量，然后按<Alt>+<Shift>+<J>快捷键，Eclipse会自动添加JavaDoc文档注释结构，如果是方法的话，还会自动添加参数名称。

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