从0开始学Java-7 代码注释与编码规范

6.1 代码注释

6.1.1 单行注释

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

语法：//注释内容

例如：

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

6.1.2 多行注释

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

语法：

/*

注释内容1

注释内容2

...

*/

注意：多行注释可以嵌套单行注释；多行注释不可以嵌套多行注释。

6.1.3 文档注释

“/** */”为文档注释标记。符号“/**”与“*/”之间的内容均为文档注释内容。

 

6.2 编码规范

1.每条语句尽量单独占一行，每条语句都要以分号结束；

2.在声明变量时尽量使每个变量单独占一行，即使有多个数据类型相同的变量，也应将其各自放在单独的一行上，这样有助于添加注释。对于局部变量，应在声明的同时对其赋予初值；

3.在Java代码中，空格仅提供分隔使用，无其他含义，开发者应控制好空格的数量，不要写过多的无用空格；

4.为了方便日后的维护，不要使用技术性很高、难懂、易混淆的语句。因为程序的开发者与维护者可能不是同一个人，所以应尽量使用简洁、清晰地代码编写程序需要的功能。

5.对于关键的地方要多加注释，这样有助于阅读者了解代码的结构与设计子路。