《代码整洁之道》——(2)函数
目录
1.1、短小
函数的第一规则是要短小。
代码块和缩进
if语句、else语句、while语句等,其中的代码块应该只有一行。该行大抵应该是一个函数调用语句。这样不但能保持函数短小,而且,因为块内调用的函数拥有较具说明性的名称,从而增加了文档上的价值。
这也意味着函数不应该大到足以容纳嵌套结构。所以,函数的缩进层级不该多于一层或两层。
1.2、只做一件事
函数应该做一件事。做好这件事。只做一件事。
如果函数只是做了该函数名下同意抽象层上的步骤,则函数还是只做了一件事。编写函数毕竟是为了把大一些的概念(换言之,函数的名称)拆分为另一个抽象层上的一系列步骤。
1.3、每个函数一个抽象层级
自顶向下读代码:向下规则
我们想要让代码拥有自顶向下的阅读顺序。我们想要让每个函数后面跟着位于下一抽象层级的函数,这样一来,在查看函数列表时,就能循抽象层级向下阅读了。
1.4、switch语句
将switch语句埋到抽象工厂底下。
1.5、使用描述性的名称
别害怕长名称。长而具有描述性的名称,要比短而令人费解的名称好。长而具有描述性的名称,要比描述性的长注释好。
1.6、参数函数
1.6.1、一元函数的普遍形式
1.6.2、二元函数
有两个参数的函数要比一元函数难懂。
1.6.3、三元函数
有三个参数的函数要比二元函数难懂的多。排序、琢磨、忽略的问题都会加倍体现。建议你在写三元函数前一定要想清楚。
1.6.4、参数对象
如果函数看来需要两个、三个或三个以上参数,就说明其中一些参数应该封装为类了。