使用注释可以提高程序的可读性,帮助程序员更好地阅读和理解程序。在Java源程序文件的任意位置都可添加注释语句。注释中的文字Java编译器不进行编译,所有代码中的注释对程序不产生任何影响。Java语言提供三种添加注释的方法,分别为单行注释、多行注释和文档注释。
“//”为单行注释标记。从符号“//”开始直到换行为止的所有内容均作为注释而被编译器忽略。
单行注释语法如下。
//注释内容
例如,以下代码为声明的int型变量添加注释:
int age ; //定义int型变量用于保存年龄信息
“/* */”为多行注释标记,符号“/*”与“*/”之间的所有内容均为注释内容。注释中的内容可以换行。
多行注释语法如下。
/*
注释内容1
注释内容2
…
*/
有时为了多行注释的美观,编程人员习惯在每行的注释内容前面加入一个“*”号,构成如下的注释格式。
/*
*注释内容1
*注释内容2
*…
*/
“/** */”为文档注释标记。符号“/**”与“*/”之间的内容均为文档注释内容。当文档注释出现在声明(如类的声明、类的成员变量的声明、类的成员方法声明等)之前时,会被Javadoc文档工具读取作为Javadoc文档内容。文档注释的格式与多行注释的格式相同。对于初学者而言,文档注释并不是很重要,了解即可。
文档注释语法如下。
/**
* 注释内容1
* 注释内容2
* …
*/
其注释方法与多行注释很相似,但它是以“/**”符号作为注释的开始标记。与单行、多行注释一样,被“/**”和“*/”符号注释的所有内容均会被编译器忽略。