代码整洁之道- 函数

Posted 2021-02-18 可口可乐嗨

函数

参考书籍：《代码整洁之道》，语言：Python

1.函数要短小

1）每个函数只做一件事，并且每个函数都依次把你带到下一个函数，这就是函数应该达到的短小程度。

2）if, else, while等语句的代码块应该只有一行，该行大概是一个函数的调用（具有说明性的函数名称会增加代码的可读性）

3）编写函数是为了把一个大的概念（函数名）拆分成另一个抽象层级上的一系列步骤

4）判断函数是否只做了一件事？ > 看其能否再拆出一个函数，并且拆出的函数不能只是单纯的重新诠释其实现

 

2.给函数取个描述性的名称

1）给函数取一个能说明其功能的名称，长而具有描述性的名称比短而令人费解的名称好

2）命名方式要保持一致，使用与模块名一脉相承的短语、名词、动词来给函数命名

 

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

1）现象：函数中混杂着不同的抽象层级让读者无法判断某个表达式是基础概念还是细节

2）建议：用自顶向下规则，尽量让每个函数后面都跟着位于下一个抽象层级的函数

　　（程序像一系列to起头的段落，描述当前的层级函数，并引用位于下一层级的函数）

 

4.分割指令与询问

将函数做了什么事和回答了什么事分开，如果两者都做，则容易引起混乱

 

5.消除重复代码

重复的代码会导致代码臃肿，不利于维护。比如，当需要修改一段逻辑时，可能需要修改多个位置