《代码整洁之道》- 提炼

258 阅读2分钟

内容提要

软件质量,不但依赖于架构及项目管理,而且与代码质量紧密相关。

代码质量与其整洁度成正比。
干净的代码,既在质量上较为可靠,也为后期维护、升级奠定了良好基础。

5s 原则:

  • 整理/组织 Sort
  • 整顿/整齐 Seiton
  • 清楚 Seiso
  • 清洁 Seiketsu
  • 身美 Shitsuke

第一章 整洁代码

定义:

整洁的代码只做好一件事 - Bjarne C++之父

糟糕的代码想做太多事,它意图混乱、目的的含混。
整洁的代码力求集中。
每个函数、每个类和每个模块都在全神贯注于一事,完全不受四周细节的干扰和污染。

简介的代码简单直接,整洁的代码如同优美的散文。
整洁的代码从不隐藏设计者的意图,充满了干净利落的抽象和直截了当的控制语句。-Grady

整洁的代码应由作者之外的开发者阅读和增补。它应该有单元测试和验收测试。它使用有意义的命名。 如果每个例程都让你感到深合己意,那就是整洁代码。
它只提供一种而非多种做一件事的途径。它只有尽量少的依赖关系,并且要明确地定义和提供清晰、尽量少的API。
代码应通过其字面表达含义,因为不同的语言导致并非所有必要信息均可通过代码自身清晰表达。

简单代码规则,

  1. 能通过所有测试
  2. 没有重复代码
  3. 体现系统中全部设计理念
  4. 包括尽量少的实体,比如类、方法、函数等

如果每个例程都让你感到深合己意,那就是整洁代码。
如果代码让编程语言看起来像是在专门解决那个问题而存在,就可以称为漂亮的代码。

清理并不一样花多少功夫,也许只是改好一个变量名,拆分一个有点过长的函数,消除一点点重复代码,清理一个嵌套if语句。

本书只能做到的,只是展示好程序员的思维过程,还有他们使用的技巧、技术和工具。

第二章 有意义的命名

待更新