Press ESC to close

代码注释与编规范

1. 代码注释

通过在程序代码中添加注释可提高程序的可读性。注释中包含了程序的信息,可以帮助程序员更好地阅读和理解程序。

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

1.1 单行注释

//为单行注释标记,从//开始直到换行欸子,所有内容均作为注释而被编译器忽略。

语法如下:

//注释内容

1.2 多行注释

/* */为多行注释,符号/*与*/之间的所有内容均为注释内容,注释中的内容可以换行。 且在多行注释中可嵌套单行注释。

语法如下

/*

注释内容1 //嵌套的单行注释

注释内容2

……

*/

1.3 文档注释

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

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

2. 编码规范

每条语句尽量单独占一行,每条语句都要以分号结束。

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

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

程序的开发者与维护者可能不是同一个人,所以应尽量使用简洁、清晰的代码编写程序需要的功能。

对于关键的方法要多加注释,这样有助于阅读者了解代码的结构与设计思路。

程序代码中的分号必须为英文状态下输入的