我们每个人刚开始编程写代码时,函数总是写得冗长而复杂,有太多的缩进和嵌套循环,有过长的参数列表。函数名称是随意取的,也会有重复代码出现在不同函数体中。但是,这没有关系,写好函数重在细节+耐心打磨。我们需要多几次分解函数,修改函数名称,消除重复,重新安置函数,甚至拆散类。打磨函数,规范代码本身就是工匠精神的体现,所以这一切很正常。
如何写好代码中的函数?也许我们需要注意这些。
短小
俗话说:函数的第一规则是短小,第二规则是还要更短小。保证一个函数只做一件事,它最长不过20行左右。
在遇到if语句,else语句,while语句等,其中的代码应该只保持一行。该行大抵是一个函数调用语句。这样不但能保持函数短小,而且,块内调用的函数拥有较为具体说明性的名称,从而增加了代码的可读性。这样,函数的缩进层级不该多于一层或两层。
只做一件事
函数应该只做一件事。编写函数是为了把大一些的概念拆分为另一抽象层上的一系列步骤。函数只做一件事指的是在函数本身这一抽象层级上的一件事儿,具体的实现步骤,可以通过实现下一层级的函数来调用。
如果函数还可以拆分出另一个函数或者可以被划分为多个区段,则该函数违反了"一件事"原则。
每个函数一个抽象层级
函数中的语句都要在统一抽象层级上,你可能会调用某个较高层级的函数,例如实现猫图像识别的函数,但在该函数底部却输出该图像到磁盘上。调用猫识别的函数抽象较高,后面输出太过于具体,违反了"一个抽象层级"的原则。
switch语句
尽量避免使用switch语句,switch语句太长,它明显做了不止一件事。如果无法避免switch,尽量让每个分支在统一抽象级上。
使用描述性名称
函数一般是一个动宾短语,不用怕名称太长,尽量保持描述性。另外,在同一抽象层级上的函数保持函数命名方式一致。
函数参数
函数参数理想情况为0个,其次是1个,再次是2个,尽量避免3个。函数参数最好不作为返回值。如果确实有很多内容需要作为参数传进函数,可以归纳参数的一致性并封装成类,作为对象传进函数。
分割指令和询问
函数要么做了一件事,要么用于判断一件事。一个函数最好不要同时把做的事情和需要判断的条件放在一个函数体中。这属于两件事。
避免重复
不同的函数体中如果出现相同或者相似功能的语句,最好抽象成函数统一起来,避免代码冗余。