设计模式：改善代码质量的20条编程规范

一、编程规范：命名与注释

1、命名

命名的关键是准确达意。对于不同作用域的命名，适当选择不同长度（利用上下文简化命名）。作用域小的变量（临时变量），可适当选择短一些的命名方式。命名使用一些耳熟能详的缩写。

利用类的信息来简化属性，函数的命名，利用函数的信息来简化函数参数的命名。

命名要可读，可搜索。不要使用生僻的，不好读的英文单词来命名。命名要符合项目的统一规范，不要用些反直觉的命名。

接口有两种命名方式：一种是在接口中带前缀“I”,另一种在接口实现类带后缀“Impl”。

抽象类命名：一种带前缀“Abstract”,一种不带前缀。和项目统一

2、注释

注释目的：让代码更容易看懂

注释内容：做什么，为什么，怎么做，对于复杂类或者接口，还要写明“如何用”

注意点：注释有成本，不是越多越好。类和函数一定要写注释，尽可能全面详细，而函数内部注释要相对少一些，一般靠好的命名，提炼函数，解释性变量，总结性注释来提代码可读性。

二、编程规范：代码风格

1、函数，类多大合适

函数的代码行数不要超过屏幕的大小，比如50行。类的大小限制比较难确定。

2、一行代码多长合适

最好不要超过ide显示的宽度。也不能限制太小，导致稍长语句被折成两行，影响整洁和阅读。

3、善用空行分割单元块

对于比较长的函数，为了逻辑清晰，可用空行分割各个代码。在类内部，成员变量与函数之间，静态成员变量与普通成员变量之间，函数之间，甚至成员变量之间，都可以通过空行方式，让不同模块的代码之间的界限更加明确。

4、四格缩进还是两格缩进

两格缩进节省空间，不要用tab键缩进

5、大括号是否要另起一行

大括号放到上一条语句同一行，节省代码行数。但另起一行，左右括号垂直对齐，代码归属更清晰

6、类中成员的排列顺序

按照google java编程规范。依赖类按照字母序从小到大排列。类中先写成员变量后写函数。成员变量之间或者函数之间，先写静态成员变量或者函数，后写普通变量或者函数，按照作用域大小依次排列。

三、编程规范：编程技巧

1、将复杂的逻辑提炼拆分成函数和类

2、通过拆分成多个函数或将参数封装为对象的方式，来处理参数过多的情况

3、函数中不要使用参数来做代码执行逻辑控制。拆分多个函数（单一职责，接口隔离原则）

4、函数设计要职责单一

5、移除过深的嵌套层次，方法包括：

• 去掉多余的if或else语句：多个if条件合并
• 调整执行顺序：先判空就不需要else
• 部分嵌套逻辑封装成函数调用
• 使用continue,break,return提前退出嵌套
• 使用多态替换if else，switch case

6、用字面常量取代魔法数

7、用解释性变量来解释复杂表达式，提前可读性