欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

cleanCode[2]:函数编写的几大规则

程序员文章站 2024-03-21 20:12:58
...

函数编写的几大规则

很难一开始就遵循这些规则,但是可以先想什么就写什么,然后再打磨它。

1、短小

函数的第一规则是短小,第二规则是还要更短小。

if、else、while语句等,其中的代码块应该只有一行。

2、只做一件事

函数应该做一件事,做好这件事,只做这一件事。

编写函数毕竟是为了把大一些的概念拆分成另一抽象层上的一系列步骤。

3、自顶向下读代码:向下规则

我们想要让代码拥有自顶向下的阅读顺序。让每个函数后面都跟着位于下一抽象层级的函数,这样在查看函数列表时,就能循抽象层级向下阅读。

4、函数参数命名

对于一元函数,函数和参数应当形成一种非常良好的动词/名词对形式。

例:

write(name); 

writeField(name);
5、使用异常替代返回错误码

如果使用异常代替返回错误码,错误处理代码就能从主路径代码中分离出来,得到简化。

6、抽离Try/Catch代码块

最好吧try和catch代码块的主体部分抽离处理,另外形成函数。