IT兄弟连 Java语法教程 注释与编码规范

Posted 2022-05-25 itxdl

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

 

代码注释

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

●  单行注释

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

//注释内容

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

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

●  多行注释

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

/*

*注释内容1

*注释内容2

*…

*/

在多行注释中可以嵌套单行注释，例如：

/*

*程序名称：Hello word //开发时间：2018-7-25

*/

但在多行注释中不可以嵌套多行注释，那样是非法的。

●  文档注释

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

/**

*注释内容

*/

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

 

编码规范

在学习开发的过程中要养成良好的编码习惯，因为规整的代码格式会给程序的开发与日后的维护提供很大方便。在此对编码规范做了以下总结：

●  每条语句要单独占一行，一条命令要以分号结束。

●  在声明变量时，尽量使每个变量的声明单独占一行，即使是相同的数据类型也要将其放置在单独的一行上，这样有助于添加注释。对于局部变量应在声明的同时对其进行初始化。

●  在Java代码中，关键字与关键字间如果有多个空格，这些空格均被视为一个。多行空格没有任何意义。为了便于理解、阅读，应控制好空格的数量。

●  为了方便日后的维护，不要使用技术性很高、难懂、易混淆判断的语句。由于程序的开发与维护不能是同一个人，所以应尽量使用简单的技术完成程序需要的功能。

●  对于关键的方法要多加注释，这样有助于阅读者了解代码结构。