Java-Java中的代码注释与编写规范

---

前言

在编写程序时，在代码程序中适当地添加注释可以提高程序的可读性和可维护性。代码的注释并不会参与编译运行，但却非常重要。
代码写出来是为了给人看的, 更是为了给三个月后的你自己看的。
而在学习开发过程中规整的代码格式会给程序会给程序的开发和日后的维护提供极大的便利。

---

1、注释

1.1、注释的规则

● 单行注释：//注释内容

● 多行注释：/* 注释内容 */

● 文档注释： /** 文档注释 */

1.2、注释的规范

1.内容准确：注释内容要和代码一致，匹配，并在代码修改时及时更新。
2.篇幅合理：注释应当精简，篇幅不可过长。
3.多行注释不能嵌套使用
4.不论是单行还是多行注释，都不参与编译，即编译之后生成的.class文件中不包含注释信息。

2、编码规范

☑ 每条语句要单独占一行，一条命令要以分号结束；
☑ 在声明变量时，尽量使每个变量的声明单独占一行，即使是相同的数据类型也要将其放置在单独的一行上，这样有助于添加注释。对于局部变量应在声明的同时对其进行初始化。
☑ 在Java中关键字和关键字当中有多个空格，都会被视为同一个，为了便于理解、阅读，应当控制好空格的数量。
☑ 对于关键字应该多加注释，这样有助于使用者了解代码结构。

总结

以上就是对本次学习内容的总结，在学习和使用过程中代码的注释和规范极其重要，一个良好的程序中的程序注解要占程序代码总量的20% ~ 50%。希望自己以及各位可以养成良好的编程习惯。