格式

1. 垂直格式

• 短的源文件比长的源文件会更好，一般在200行~500行之间为好
• 源文件的结构应该是从上往下展开，顶部是高层次概念，底下是实现细节，可以简单理解为 public 放在前，private 放在后
• 每组代码应该是完整的一条思路，不同组代码之间应该用空白行隔开
• 相关代码应该靠近，避免把相关的概念放到不同文件中，即避免过度使用 protected
• 变量声明应该尽可能靠近其使用位置
• 实体变量应该在类的顶部声明
• 函数调用应该放在一起，也就是被调用者在调用者的下面，保持程序的顺序性
• 概念相关的代码应该放在一起，相关性越强，彼此之间的距离就应该越短

2. 水平格式

注释

1. 注释的作用

• 为了弥补代码表达某种意图时不够清晰的一种手段

2. 注释的缺点

• 需要写注释，就说明代码很糟糕，代码不能够清晰表达它的意思
• 注释会随着时间变得腐烂，离其描述的代码越来越远，甚至变得全部是错误的，因为程序员往往不能坚持维护注释

3. 好注释

函数

1. 短小

• 函数在保证完整性的情况下，越短越好
• 每个函数都应该一目了然
• 长度为 20 行最佳

2. 只做一件事

• 每个函数应该保证只做一件事
• 要判断函数是否只做了一件事，可以看是否还能再拆出一个函数
• 一件事是指在同一抽象层次上完成的动作

3. 每个函数一个抽象层级

有意义的命名

1. 名副其实

• 变量、函数或类的名称应该能够准确地说明它的意义，比如它存在的意义，它做什么事，以及它应该怎么用。

• 一旦发现好的命名，就应该换掉旧的名称（当然要确定修改的难易程度）。

2. 避免误导