3. 注释与格式

注释的作用是弥补我们在用代码表达意图时遭受的失败

注释就是一种失败，用代码来表示意图才是真正需要的。

1. 注释不能美化糟糕的代码
   写注释的时间，不如美化糟糕的代码

2. 有的时候，代码不能用来阐述，有的时候只需要创建一个描述与注释所言一样的函数即可。

3. 好注释
   包括法律信息，提供信息的，对意图的解释，警示，todo注释，公共api注释。

4. 坏注释
   包括喃喃自语，多余的注释，可能会误导的注释，循规蹈矩的注释，日志，归属和署名，注释掉的代码。
   能用函数或者变量时，就不要用注释

格式关乎沟通，沟通才是开发的大事。

1. 越短的文件越容易被理解，平均200行左右

2. 排版要向报纸学习，从上到下一目了然。
   顶层诶出高层次的概念和算法，细节向下依次展开

3. 不同概念间要有空行隔离
   靠近的代码暗示了他们关系的紧密

4. 概念相关的函数要放在一起，同时自上而下展示调用依赖顺序。