菜鸟笔记 -- Chapter 4.7 代码注释与编码规范

4.7 代码注释与编码规范

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

4.7.1 代码注释

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

单行注释

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

//注释内容  

如 static int age ; //当变量要被静态方法引用时,变量要静态化 

后面文字是对前面代码的书面解释

多行注释

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

/*

注释内容1

注释内容2

......

*/

注意:多行注释中可以嵌套单行注释,但不可以嵌套多行注释,多行注释中如果嵌套多行注释会出现错误，是非法代码。如下:   /*  多行注释中如果嵌套多行注释会出现错误  /*  这时第一个多行注释开始会和里面嵌套多行注释的结束符,组成一个多行注释,而最外围的就成了被编译器编译的内容,此时编译器会因无法识别而报错*/....*/

文档注释

 

文档注释是java特有的注释，其中注释内容可以被JDK提供的工具 javadoc 所解析，生成一套以网页文件形式体现的该程序的说明文档。

注释是一个程序员必须要具有的良好编程习惯。初学者编写程序可以养成习惯：先写注释再写代码。

将自己的思想通过注释先整理出来，在用代码去体现。因为代码仅仅是思想的一种体现形式而已。注意编译后注释是不会出现在中间吗中的。

4.7.2 编码规范