整洁代码--写好方法(函数)

来源:互联网 发布:淘宝lgg5怎么这么便宜 编辑:程序博客网 时间:2024/06/06 12:26

1.尽量短小

在不影响功能的情况下尽可能的把方法写的小一些,尽量不要出现成千上万行的方法。

2.一个方法只做好一件事

不要让一个方法做过多的事情,会让初看代码的人很迷茫,一个好的方法要让读者大概看一遍就知道这个方法是要做什么,而不是茫茫多的功能。

3.方法的分层

现在绝大部分主流语言会分为web层,server层,和dao层,一个好的方法首先要确定目前的类是写在哪个层,在哪个层就用哪个层的代码不要越层使用。在分好层的情况下,要自上而下的调用代码,如web调用server,server调用dao等。

4.见名知意的名称

小学作文中的开门见山就是这个效果,让读者看过方法名称就明白你要做什么,然后顺着你的思路进行阅读代码,会事半功倍。不要怕方法名称长,再长的名称也比看不懂的名称要好。

5.尽量少的参数

一个好的方法,参数越少越好,参数越少,读者越容易搞明白方法的含义,如果一个方法传入参数大于三个,那就一定要把这些参数重构成一个类了。

6.不要是用输出函数

我身边从来没有任何人使用过输出函数,但根据前辈描述,确实有这种存在,他会让读者在面对参数时多一层考虑,到底是输入函数还是输出函数,虽然不常用,但也是列举出来。

7.选择合适的异常处理方式

要根据当前代码的自身情况选择try catch 还是throw,异常处理在代码整体结构处理上很重要,一句两句说不明白,我会起专门的篇幅进行异常处理的总结。

8.抽离 try/Catch 代码块

可以根据代码情况抽离try/catch为一个新的方法,这样代码比较整洁,但我不是很喜欢这种方式。

9.不要有重复的代码

不写重复的代码,其实不光是方法,整个面向对象的编程都是这样。如果你发现你在重复的写某一段代码,这说明你应该给他重构为一个类了。

10.选择性的使用结构化编程规则

Edsger Dijkstra 结构化编程规则告诉我们,一个方法应该只有一个return,循环中不能有break 或 continue 语句(即单入单出)。这种方式在大篇幅的代码情况下是很有必要的,如果代码并不多偶尔出现return、break、continue 语句并没有坏处,或许能让人更加明朗。

11.总结

写好一个方法,其实并不那么容易,绝大部分漂亮的代码都是先将代码功能写好,然后不断的重构,打磨,才出现让人清晰明了的结构,最终实现上述效果。好的代码就像写文章,讲故事,记住这点。

本文为阅读书籍、向资深程序员请教、以及自身摸索得出,如遇版权,请及时联系。
欢迎转载,但希望注明出处,谢谢。

0 0