一、道
1.1代码的组成。
变量
变量+操作符=表达式
表达式+语句=函数
函数+数据结构=类
简而言之：代码由变量，表达式，函数，数据结构，类组成。
1.2可读性
变量，函数，类，文件等代码的组成元素都必须由准确且有意义的命名。代码组织必须条理清晰，重点明确。
1.3单一职责
变量，函数，类，文件等都应该尽可能只做一件事。变量不应该代表多个含义，函数不应该实现多个不相关的功能，类不应该包含多个概念，文件不应该包含不同的大功能。
1.4封装
对函数，为了保持函数的短小，考虑把实现细节封装成函数。对于函数参数，当参数过多时，考虑封装成数据结构，或者用类代替函数。
对于类，内部要封装数据结构和具体实现，只提供调用方需要的接口。用超类代替具体实现的子类，利用堕胎封装子类的实现。
对于外部引入的库，封装其提供的接口，当外部接口改变时，不需要改变调用，只需要改变封装的类。
1.5通过测试来驱动系统设计和迭代
单元测试必不可少。
单元测试应先于生产代码。
系统设计必然要经过多次迭代。
迭代必然会引入新的问题。
单元测试可以保证迭代引入的问题被发现。
1.6代码编写心态
代码正常运行是代码存在的意义
迭代必然发生，要考虑代码长远的发展
二、细则Tips
2.1命名
a.命名要精确==》避免歧义如（1 l） 区分要有意义（Data Info）
b.命名需要具有可读性。
c.变量需要考虑全局唯一==》便于搜索
d.根据读者确定代码命名==》使用应用领域的专有名词
e.命名一以贯之==》用同一个单词表示同一个概念 不同的概念使用不同的单词
2.2函数
a.函数要短小==》单一职责原则把功能拆分 封装原则把部分实现封装成函数
b.减少参数==》同类参数封装成数据结构
c.函数以动词开头==》如On Get Set Add Insert Del Check Handle Deal
d.DRY==》Do not Repeat Yourself。避免重复代码
2.3注释
任何注释都需要思考，这个注释可以不需要吗？能否通过别的手段实现注释的目的？
2.4风格
意图：优化整体代码的布局
a.代码分块 用空行隔开==》根据相似性和调用关系分块
b.声明和使用的关系==》注意声明使用的作用域 限定其声明的位置
c.函数顺序==》被调用方在调用方下面 当代码阅读时可以很方便的切换到实现（C++是特例）
d.注意代码的高度和宽度==》增加一个屏所能展示的信息
2.5对象和数据结构
a.数据结构应只有公共数据，没有任何方法。
b.对象应只有调用者需要的接口，没有暴露数据和实现的方法。
2.6错误处理
a.错误码和异常的抉择==》异常的好处是把正常逻辑和异常逻辑分开
b.可控异常存在的问题==》可控异常是典型的违背封装原则的示例 调用方需要清楚底层的异常并且新增异常时 需要跟着修改
2.7边界处理
a.测试边界代码==》边界代码的测试有助于理解边界代码 同时保证边界代码的可靠性
b.适配器适配三方接口==》1.更优的接口 2.可替换的第三方 3.三方修改时 不需要同步变化
2.8单元测试
a.单元测试代码的格式==》Give When How 给定测试目标 设置测试条件 判定测试结果
b.双重标准==》测试代码更不注重运行效率 更注重可读性以及开发效率
c.单一职责==》一个用例只测试一个特性
2.9类
a.单一职责==》一个类只定义一个概念
b.内聚==》类成员被方法使用的频率 频率越高 越内聚
2.10迭代
a.迭代具有必然性==》当前的代码需要具有可读性
b.迭代时DRY==》将旧代码中重复的部分封装
三、总结
软件工程是一门技艺，需要设计原则和经验积累。设计原则把控总的方向，经验积累则是编码时具体的Tips，每个Tips都是在指导原则下，解决特定问题的更优解。
