《代码整洁之道》读后总结--关于方法

1.几个问题：

Q1:  怎样让代码（函数中含有大量的代码行，大量的信息）易于理解？

Q2:  怎样让函数表达其意图？

Q3:  给函数哪些属性，以便让读者一看便明白函数术语怎样的程序？

2.简单的原则：

2.1. 短小

• 作者认为函数应该尽量短小。
• 每行字符的数量要有限，  并且 每个 函数20行 封顶最佳。（建议）
• if语句 ， else 语句， while语句中等， 代码块应该只有一行 （函数调用语句）。
• 函数不应该大到足以容纳嵌套结构。（表现为 缩进层级 <= 1层 或者 2层）

2.2. 只做一件事情

• 函数只做一件事情。 做好这件事情。这做这件事情。
• 判断 1：如果函数只是做了该函数名下同一抽象层次上的步骤，函数做了一件事情。

什么叫做同一抽象层次？

• 判断2 ：看是否能从函数中再拆出一个函数。

2.3.　每个函数一个抽象层次

确保函数只做一件事情　。　＜－－　（函数中语句在同一抽象层次）

• 函数抽象层次混杂造成的影响， 让人困惑不解。（读者无法判断是基础概念，还是细节）
• 混杂还会进一步，让更多的细节在函数中纠结起来。
• 自顶向下读代码： 向下规则

每个函数后面都跟着下一抽象等级的函数。这样子便可以循抽象层级向下阅读。

（想象一棵层次树，不同层级代表不同的抽象等级）

（分层的结构在这里也得到了很好的体现）

（体现为句法为 ：  为了（TO） ...，而 ...）

程序员需要确保自己写出只停留于一个抽象等级上的函数。（不要在多层之间混淆）

2.4. Switch语句

• 写出短小的switch语句很难。switch 天生要做N件事情。
• 确保switch 埋藏在较低的抽象层次，且永远不重复。（通过多态来实现这一点）
• 例 ：  将switch 语句埋到抽象工厂底下，不让任何人看到。
  
• 作者的规矩： switch 只出现一次，这一次用来创建多态对象。（好的技巧）

2.5. 使用描述性的名称

• 函数长而具有描述性的名称，比描述性的长注释要好。
• 别怕花时间取名字。
• 选择描述性的名称能理清你关于模块的设计思路，帮你改进。追求好名称，往往导致对代码的改善重构。
  
• 命名方式要保持一致。使用与模块名具有相似性的短语，名词，动词给函数名。例如，includeSetupAndTeardownPages, includeSetupPages, includeSuiteSetupPage...。
  

2.6. 函数参数

待续...