Coding Standard: Improve Code Quality
代码的质量
提高代码质量的途径有:合理应用设计原则和设计模式,按照编码规范提高代码细节层面的质量。
编码规范
编码规范大体分为三个部分:
-
命名与注释:Naming and Comments
-
代码风格:Code Style
-
编程技巧:Coding Tips
命名与注释
命名的标准
-
长度
-
利用上下文简化命名
-
可读
-
与团队风格一致
接口的常见命名风格:
-
IxxxService/xxxService
-
xxxService/xxxServiceImpl
抽象类的常见命名风格:
- AbstractXxxxx/Xxxxx
注释的必要性
是否好的变量命名可以替代注释?
编程技巧
-
把代码分割成更小的单元块
-
避免函数参数过多
-
尽量不要用函数参数来控制逻辑
-
函数设计要职责单一
-
移除过深的嵌套层次
-
使用解释性变量