代码注释规范

通过在程序代码中添加注释可提高程序源代码的可读性。注释中包含了程序的信息,可以帮助程序员更好地阅读和理解程序代码。在Java源程序文件的任意位置都可添加注释语句。注释中的文字Java编译器不进行编译,所有代码中的注释文字对程序不产生任何影响。Java语言提供了3种添加注释的方法,分别为单行注释、多行注释和文档注释。

单行注释

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

//此处为注释内容

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

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

多行注释

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

 /*
 注释内容1
 注释内容2
 ……
 */

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

/*
 程序名称: Hello word    //开发时间:2030-10-5
 */

但在多行注释中不可以嵌套多行注释,以下代码为错误语法:

/*
 程序名称: Hello word
 /*开发时间: 2030-10-5*/
*/

文档注释

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

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

发表评论