代码整洁之道简要

一，命名可读，有意义，避免歧义

二，函数：短小，只做一件事

if语句，while语句，其中的代码块应该只有一行。该行大抵应该是函数调用语句，这样调用函数拥有较具说明性名称

函数的参数应该越少越好，多于3个就应该封装成类

避免使用输出参数

使用异常替代返回错误码

三：注释

如果能用函数名称，就尽量不注释

todo注释：认为应该做但由于某些原因目前还没有做的工作

四：格式

垂直格式：短小，应该100到200行

文件最顶部应该给出高层次概念和算法，细节应该往下渐次展开，直至找到源文件中最底层的函数和细节

五 对象和数据结构

过程式代码（使用数据结构的代码）便于在不改动既有数据结构的前提下添加新函数，

面向对象代码便于在不改动既有函数的前提下添加新类

过程式代码：定义几个class 专门用来存数据。一个class专门存放方法，方法对传入的类做判断，然后写具体方法。所以不改动数据结构添加新函数比较方便

面向对象：每个类都有操作方法。所以添加新类方便

六，错误处理

如果将错误处理隔离看待，独立于主要逻辑之外，就能写出强固而整洁的代码

七 边界

第三方提供的接口就是边界接口。

学习边界接口最好的方法是写测试用例

对于可能需要更换的接口，我们要对第三方接口进行封装，避免依赖。

八测试

1，快速：测试应该能快速运行

2，独立：测试应该相互独立、

3，可重复

4，自足验证：测试应该有布尔值输出

5，及时：单元测试应该在生产代码之前编写，

如果在编写代码之后编写测试，你会发现生产代码难以测试。你可能会认为某些生产代码本身难以测试。你就可能不会去设计可测试的代码

九，类

类应该从一组变量列表开始。如果有公共静态常量，应该先出现，然后是私有静态变量，以及私有实体变量，很少有公共变量

公共函数跟在变量列表之后。我们喜欢把由某个公共函数调用的私有工具函数紧随在该公共函数后面。这符合自顶向下原则。

类应该只有一个权责--只有一条修改的理由。

高内聚：只有少量实体变量，类中的每个方法都应该操作一个或多个这种变量。如果一个类中的每个变量都被每个方法所使用，则该类具有最大的内聚性。

、、未完待续