- 提倡良好的代码风格
1、整洁
2、统一
3、流行
4、便捷
现在的项目中源代码主键增多,完全依靠人工来做代码走查很难查出问题,我们可以使用工具来统计代码,这里推荐使用Checkstyle,他可以自定义代码模板,然后根据模板检查代码是否遵循规范,从而减少枯燥的代码走查。
- 不要完全依靠单元测试来发现问题
不能保证代码中的所有错误都能被单元测试挖掘出来,原因有以下四点。
1、单元测试不可能测试所有的场景(路径)
2、代码整合错误是不可避免的
3、部分代码无法(或很难)测试
4、单元测试验证的是编码人员的假设
- 让注释正确、清晰、简洁
不好的注释习惯:
1、废话式注释
2、故事式注释
3、不必要注释
4、过时的注释
5、大块注释代码
6、流水账式注释
7、专为JavaDoc编写的注释
好的注释习惯:
1、法律版权信息
2、解释意图的注释
3、警示性注释
4、TODO注释
- 让接口的职责保持单一
单一职责有以下三个优点:
1、类的复杂度降低
2、可读性和可维护性提高
3、降低变更风险
如何实施单一职责原则:
1、分析职责
2、设计接口
3、合并实现
注意:接口职责一定要单一,实现类职责尽量单一。
- 增强类的可替换性
设计类的考虑以下三点:
1、子类型必须完全实现父类型的方法
2、前置条件可以被放大
3、后置条件可以被缩小
- 依赖抽象而不是实现
遵循以下几个规则:
1、尽量抽象
2、表面类型必须是抽象的
3、任何类都不应该从具体类派生
4、尽量不要覆写基类的方法
5、抽象不关注细节
- 抛弃7条不良的编码习惯
1、自由格式的代码
2、不使用抽象的代码
3、彰显个性的代码
4、死代码
5、冗余代码
6、拒绝变化的代码
7、自以为是的代码
- 以技术员自律而不是工人
1、熟悉工具
2、使用IDE
3、坚持编码
4、编码前思考
5、坚持重构
6、多写文档
7、保持程序版本的简单性
8、做好备份
9、做单元测试
10、不要重复发明轮子
11、不要拷贝
12、让代码充满灵性
13、测试自动化
14、做压力测试
15、“剽窃”不可耻
16、坚持向敏捷学习
17、重里更重面
18、分享
19、刨根问底
20、横向扩展