编程修炼之方法论篇--编写可读代码

参考：编写可读代码的艺术

可读性定理：代码的写法应当使别人理解它所需的时间最小化

表面层次的改进

选择好的名字、写好的注释以及把代码整洁地写成更好的格式。
我们喜欢把名字当做一条小小的注释。尽管空间不算很大，但选择一个好名字可以让它承载很多信息。
• 选择专业的词。
• 避免泛泛的名字（或者说要知道什么时候使用它）。
• 用具体的名字代替抽象的名字。
• 使用前缀或后缀来给名字附带更多信息。
• 决定名字的长度。
• 利用名字的格式来表达含义。

不会误解的名字，如get，filter，clip
推荐mix和max表示极限，first/last表示包含的范围

审美

• 使用一致的布局，让读者很快就习惯这种风格。
• 让相似的代码看上去相似。
• 把相关的代码行分组，形成代码块。

注释

注释的目的是尽量帮助读者了解得和作者一样多。
• 了解什么不需要注释。
• 用代码记录你的思想。
• 站在读者的角度，去想象他们需要知道什么。

不要为那些从代码本身就能快速推断的事实写注释。
记录你的思想