Clean Code读书笔记--5.格式

220 阅读3分钟

5. 格式

写代码应该保持良好的代码格式。应该选用一套管理代码格式的简单规则,然后贯彻这些规则。

如果在团队中,应该一致同意采用一套简单的格式规则,所有成员都要遵从。

5.1 格式的目的

代码格式很重要。代码格式是不可忽略的,必须严肃对待。代码格式关乎沟通,而沟通是专业开发者的头等大事。

或许在一些人眼里,“让代码能工作”才是专业开发者的头等大事。你今天编写的功能极有可能在下一个版本中被修改,但代码的可读性却会对以后可能发生的修改行为产生深远影响。原始代码修改很久,其代码风格和可读性仍会影响到可维护性和扩展性。其实代码不复存在,你的风格和律条仍存活下来。

5.2 垂直格式

写代码要向报纸学习:

  • 顶部有头条
  • 第一段是大纲
  • 细节渐次增加
  • 由多篇文章组成,多数短小精悍
垂直方向上的间隔

同时就像我们读文档每个段落之间会有空白行,代码也需要。

在每个逻辑段落之间、每个函数之间用空白行隔开,这条极其简单的规则极大地影响到代码的视觉外观。每个空白行都是一条线索,标识出新的独立概念。往下读代码时,你的目光总会停留于空白行之后那一行。

垂直方向上的靠近

空白行隔开了概念,靠近的代码行则暗示了它们之间的紧密关系。因此,紧密相关的代码应该互相靠近。

把声明和声明靠在一起,函数和函数靠在一起,调用函数的模块和函数本身靠在一起,概念相关的代码放在一起,这些都能增强代码的可读性。

5.3 横向格式

尽量保持代码行短小。尽管有时候一行代码会写到100个字符,但要是再多就不行了。

要遵循无需拖动滚动条到右边的原则。

水平方向上的区隔与靠近

我们使用空格字符将彼此紧密相关的事物连接到一起,也用空格字符把相关性较弱的事物分隔开。

function measureLine(line) {
	var lineSize = line.length();
}

如上面的代码所示,在赋值操作符周围加上空格字符,以此达到强调目的。赋值语句有两个确定而重要的要素:左边和右边。空格字符加强了分隔效果。

另外,不在函数名和左圆括号之间加空格,强调函数与其参数密切相关,如果隔开,就会显得互无关系。

但是多数的代码格式化工具都会直接格式化代码,这样看来自己一些微妙的空格用法就消失殆尽了。

水平对齐

所有代码从第一个字符开始对齐。

var a = 11111;
var aaaaaaaaaa = 1;

像上面的规则那样,会比下面的规则更好看,可读性更高。

var a          = 11111;
var aaaaaaaaaa = 1;
缩进

5.4 团队规则

每个程序员都有自己喜欢的风格、格式,但是如果在团队中工作,那就是团队说了算。

一个团队应该统一代码风格和格式,便于大家工作。

现在的很多代码格式化工具都能让这一行为很简单的实现。