代码整洁之道读书笔记——第五章：格式

第五章 格式

团队应该一致同意采用一套简单的格式规则

5.1 格式的目的

能让代码工作，这是最基本的要求。但是代码格式同样很重要，我们今天编写的功能，很有可能下一个版本就会被修改

5.2 垂直格式

短文件通常比长文件易于理解

5.2.1 向报纸学习

名称应该一目了然，而且报纸的文章多数短小精悍

5.2.2 概念间垂直方向上的区隔

变量之间可以不用空行，方法和方法间要空行，变量和方法之间也要空行，空白行隔开了概念

5.2.3 垂直方向上的靠近

靠近的代码暗示了它们之间的紧密关系，紧密相关的代码应该互相靠近

5.2.4 垂直距离

关系密切的概念应该相互靠近

局部变量的声明应该在函数顶部出现

成员变量应该在类的顶部声明

相关函数放到一起，一般调用者放到被调用者上面

概念相关的代码应该放到一起

5.2.5 垂直顺序

还是上面强调的，被调用的函数应该放在执行调用的函数下面

5.3 横向格式

无需拖动滚动条到右边的原则，现在电脑屏幕大了，可能能容纳更多的代码了

5.3.1 水平方向上的区域与靠近

一般来说，运算符左右两边都得有空格

函数名和左圆括号之间不应该加空格

5.3.2 水平对齐

不要为了对齐而对齐，那样看着太难受了，我们一般左对齐就好

5.3.3 缩进

这个是最基本的东西了，有缩进和没缩进的代码读起来就是不一样

哪怕是短小的狗仔方法或者if语句，不要为了省事写成一行，我们也应该是去正常的加上缩进

5.3.4 空范围

尽量不要使用：while或者for的语句体为空的结构

就算用了，空范围也要使用中括号

5.4 团队规则

每个程序员都有自己喜欢的风格，但是在一个团队中工作，就是团队说了算

在一个项目中，统一编码也是有必要的，比如如何命名、如何缩进，某些固定方法的位置应该放在哪里，代码注释怎么写等等

5.5 鲍勃大叔的格式规则

1. 局部变量在类顶部
2. 变量间比较紧密
3. 方法和方法间有空行
4. 被调用的方法在调用方法的下方
5. 运算符左右有空格
6. 概念相关的代码放到一起

范例代码

算了，暂时不写，略了吧，下次回来看这篇文章的时候补一个我自己写的代码

总结

格式上其实没有什么难的，就是一个规范的问题

其实格式不光是在代码中应该注意到，我们自己写文章或者在读别人写的文章的时候，都会注意那种美感的问题

尤其我们做移动端或者前端的应该对这个审美有更高的要求

写出的代码像诗一样，才是最美的