摘抄的一些编程规范

说明

2022年5月12日 下午 初版整理

1、命名

• 命名长度根据作用域选择不同长度，作用域较小的（比如临时变量），可以适当地选择短一些的命名。
• 命名中可以使用一些耳熟能详的缩写
• 借助类的信息简化属性、函数的命名
• 借助函数的信息简化函数参数的命名
• 命名要可读，可搜索。不要用生僻的，不好读的英文单词，不用反直觉的命名，命名要符合项目统一规范
• 接口两种命名方式，采用接口实现类中带后缀 “Impl” 的方式
• 抽象类采用带前缀 “Abstract“ 的方式

2、注释

• 目的是为了让代码更易读懂。内容包括：What、Why、How
• 复杂的类和接口，可能还需要写明 How to use
• 注释具有维护成本，类和函数一定写注释，尽可能全面详细。函数内部就要相对少些注释。

3、类、函数的代码行数

• 函数代码函数建议不超过 IDE 显示的一个显示屏的垂直高度
• 类的代码行数没有确切的值，需反向判断，当寻找函数时很费劲或者需要实现一个小功能就要引入整个类，此时就说明类的行数过多了

4、一行代码多长合适？

• 建议值：一行代码最长限制为 100 个字符
• 原则：一行代码最长不能超过 IDE 显示的宽度。

5、函数内部过长时如何优化

• 函数较长时，可以用空行分割逻辑上较为独立的代码块
• 每个独立的代码块前可以加上总结性的注释

6、代码缩进

• 不用Tab键，用两格空格代替
• 大括号不用另起一行，和上一条语句放在一起

7、类中成员排序

• 类所属包名
• 罗列 import 引入的依赖，不同依赖按字母顺序从小到大排列
• 类中，先写成员变量：先静态变量，再普通变量；先public，然后protected，再private
• 再写成员函数：先静态函数，再普通函数；先public，然后protected，再private

8、编码技巧

• 将复杂的逻辑提炼拆分成函数和类
• 通过拆分成多个函数或将参数封装成对象的方式来处理参数过多的情况
• 函数中不要使用参数来做代码执行逻辑的控制
• 函数设计要职责单一
• 移除过深的嵌套层次，方法包括：去掉多余的 if 或 else 语句，使用 continue、break、return 关键字提前退出嵌套，调整执行顺序来减少嵌套，将部分嵌套逻辑抽象成函数。
• 用字面常量取代魔法数
• 用解释性变量来解释复杂表达式，以此提高代码可读性