代码整洁之道
必要性
- 要有代码,大胆写,Imperfect code is Better Than Perfect
- 现在就做,later equals never,Now is better than never
- 从开始就不要为了一时便利去破坏代码整洁
- 坚持同一规范
- 隔离与性能的权衡
什么是代码整洁
应当有单元测试以及验收测试,使用有意义的命名,只提供一种做某一件事的途径(而非多种),尽量少的依赖关系,清晰并且尽量少的API
- 能通过所有测试
- 没有重复代码
- 体现系统全部设计理念
- 包括尽量少的实体,例如,类、方法、函数等
- 让读的过程轻松,即便会让写的过程更难
- 让营地比你来的时候 更干净
细节
- 名副其实
- 避免歧义,O I等,避免废话
- 使用可搜索的名称
- 类名不应当是动词
- 方法名应当是动词或动词短语
- 宁可明确,毋为好玩(生活和思想需要务虚,但code要务实)
- 避免双关语,一词一意
- 每个概念一个单词,一意一词
- 使用算法名、计算机术语、模式名、数学术语命名
- 使用所在领域命名
- 函数就该小
- 函数式编程,尽量少用副作用编程
- 做好隔离(抽象、封装、逻辑与业务隔离,实现与使用隔离)
- 函数应该做好一件事,只做一件事
- 函数参数越少越好,最好没有
- 抽离try catch代码块
- 相关联的函数应该放在一起,调用者尽可能放在被调用者上面
- tdd 规则
- 在能产生不能通过的单元测试之前,不可编写生成代码
- 只允许编写刚好无法通过的代码
- 只可编写刚好足以通过当前失败测试的生成代码
本网站内容均采用 CC-BY-NC-SA 许可协议。转载请注明来自 LongTao!
评论