3、代码注释与编码规范

目录

一、代码注释

（1）单行注释

（2）多行注释

（3）文档注释

2. 编码规范

---

一、代码注释

（1）单行注释

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

略。

语法如下：

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

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

（2）多行注释

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

以换行。

语法如下：

注意1：在多行注释中可嵌套单行注释。例如：

/*

程序名称：Hello world //开发时间：2023-01-07

*/

注意2：但在多行注释中不可以嵌套多行注释，以下代码为非法：

    /*

        程序名称：Hello world

/*开发时间：2023-01-07

作者：洋洋

 */

    */

（3）文档注释

“/** */”为文档注释标记。符号“/**”与“*/”之间的内容均为文档注释内容。当文档注释出现在声明（如类的声明、类的成员变量的声明、类的成员方法声明等）之前时，会被Javadoc文档工具读取作为Javadoc文档内容。文档注释的格式与多行注释的格式相同。

2. 编码规范

编码要点总结：

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

注意：程序代码中的分号必须为英文状态下输入的，如果写成中文的话，编译器会报出illegal character（非法字符）这样的错误信息。

• 在声明变量时，尽量使每个变量的声明单独占一行，即使是相同的数据类型也要将

其放置在单独的一行上，这样有助于添加注释。对于局部变量应在声明的同时对其进行初始化。

• 在Java代码中，关键字与关键字间如果有多个空格，这些空格均被视作一个。例如：

多行空格没有任何意义，为了便于理解、阅读，应控制好空格的数量。

• 为了方便日后的维护，不要使用技术性很高、难懂、易混淆判断的语句。由于程序的开发与维护不能是同一个人，所以应尽量使用简单的技术完成程序需要的功能。
• 对于关键的方法要多加注释，这样有助于阅读者了解代码结构。