java的代码注释

在程序代码中适当地添加注释可以提高程序的可读性和可维护性。好的编码规范可以使程序更于易阅读和理解。接下来我将介绍Java中的几种代码注释以及应该注意的编码规范。

代码注释

通过在程序代码中添加注释可提高程序的可读性。注释中包含的程序信息，可以帮助程序员更好地阅读和理解程序。在Java源程序文件的任意位置都可添加注释语句。

进行注释后，注释中的文字Java编译器不会进行编译，所有代码中的注释文字也不会对程序运行产生任何的影响。

所以我们不仅可以在注释中写程序代码的解释说明、设计者的个人信息，还可以使用注释来屏蔽某些不希望执行的代码。

Java语言给我们提供了3种添加注释的方法，分别为单行注释、多行注释和文档注释。

1.单行注释

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

语法如下:

//注释内容

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

int age;      //声明int型变量用于保存信息

2.多行注释

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

语法如下:

/*

注释内容1

注释内容2

…

*/

另外

在多行注释中也可以嵌套单行注释。

例如

/*

程序名称:Helloword  //开发时间:某年某月某日

*/

但在多行注释中不可以嵌套多行注释，以下代码为非法的:

/*

程序名称:Hello word

/*开发时间:某年某月某日

作者:某某

    */

*/

3.文档注释

“/** */”为文档注释标记。

符号“/**”与“*/”之间的内容均为文档注释内容。当文档注释出现在声明(如类的声明、类的成员变量的声明、类的成员方法声明等)之前时，会被Javadoc文档工具读取作为Javadoc文档内容。

文档注释的格式与多行注释的格式相同。对于初学者而言，文档注释并不重要，了解即可。