代码规范性

命名规范

​ 1、变量和函数名：使用驼峰命名法（camelCase），如userName、getUserInfo。

​ 2、常量：使用全大写字母，并用下划线分隔，如MAX_SIZE、DEFAULT_VALUE。

​ 3、类名：使用帕斯卡命名法（PascalCase），如UserInfo、CarService。

​ 4、文件名：与类名保持一致，或使用小写字母与下划线分隔，如user_info.py、car_service.js。

---

代码格式

​ 1、缩进：统一使用4个空格或一个制表符（tab）进行缩进。

​ 2、间隔：在运算符前后、逗号后、函数调用参数之间、函数名和括号之间、

​ 关键字（如 if ，for，while ）和随后的括号之间添加空格，提高可读性。

​ 同时避免不必要的空格，如不要在括号内部或逗号前后添加不必要的空格。

​ 3、括号：即使可以省略括号，也应该保留，以增强代码清晰度。

​ 4、对齐：确保代码对齐，使代码结构一目了然。

​ 5、变量 == null，空统一放右边。

---

注释

​ 1、文件头部：提供文件描述、作者、创建日期等信息。

​ 2、函数和类：描述其用途、参数、返回值等。

​ 3、复杂代码段：在代码上方提供简短说明。

​ 4、避免过多注释：代码应尽可能自我解释。

---

代码结构

​ 1、模块化：将代码组织成模块，每个模块负责一个具体功能。

​ 2、单一职责原则：每个类和函数应该只有一个改变的理由。

​ 3、避免过长的函数和类：保持函数和类的简短，易于理解和维护。

​ 4、空行：使用空行来分割不同的代码块，使得代码结构更加清晰。

​ 5、避免字符串多次拼接，可用String.format(“%s%s”, s1, s2)或者StringBuffer
的append()方法。

---

异常处理

​ 1、捕获具体异常：避免捕获所有异常，只捕获你预期会发生的异常。

​ 2、错误处理：不要只是打印错误信息，应该有逻辑处理错误情况。

​ 3、资源管理：确保释放所有使用的资源，如文件、数据库连接等。

​ 4、类型转换：通过instanceof判断，再做类型转换，避免类型转换异常。

​ 5、常量判断：常量放前面，如 常量.equal(变量)，避免空异常。

---

代码复用

​ 1、函数和类：如果代码段在多个地方使用，考虑将其抽象成函数或类。

​ 2、库和框架：使用现有的库和框架来避免重复造轮子。

---

代码审查

​ 1、代码审查：定期进行代码审查，由同事检查代码规范性。

​ 2、自动化工具：使用代码审查工具来检查代码质量和风格。

---

空格的用法

代码示例