写好函数的规范小结

时间：2015-11-16 01:02:18 阅读：176 评论：0 收藏：0 [点我收藏+]

标签：

《代码整洁之道》第三章的阅读小结。

写好函数：

1，短小！20行左右就是上限。
2，只做一件事！这是最重要的一点。要判断函数是否只做了一件事的方法就是看能否再拆出来一个函数。
3，每个函数一个抽象层级。自顶向下读代码：向下原则。每个函数引出下一个函数。
4，switch语句应该埋在抽象工厂底下。而面对不同类型该做不同操作的功能用多态来实现。
5，使用描述性的名称。长而具有描述性的名称最佳。命名方式（风格）应该保持一致
6，函数参数：最佳是零参数，其次是单参数，再次是二，应避免三参数及以上。
7，单参数函数的形式。三种类型：一种是该函数会“问”该参数一些问题，如检查状态。另一种是对该参数进行操作。还有一种是事件类型，有输入参数而无输出参数。对于操作参数的单参数函数，最好使用返回值而不是输出参数。StringBuffer transform（StringBuffer in）是种好的实现
8，标识参数应该避免。如往函数传入布尔值！
9，动词与关键字。函数与参数应该形成动名词形式如writeField（name）和assertExpectedEqualsActual（expected,actual）
10，无副作用。即只做一件事，不应该隐藏着另外行为，如果不得不做，最后的办法就是在函数名中披露。
11，输出参数的大部分需求已经消失，应使用类方法或者返回值。
12，分隔指令与询问。如setXXX指令的返回值不该有可能是检测参数不合法的询问值。应该分成两个函数。
13，使用异常代替错误码。错误代码就能从主路径代码中抽离出来得到简化。
14，从代码主体中抽离try catch代码块，使得主体代码专心做事，另一个函数进行可能的错误处理。因为，错误处理就是一件事。
15，避免使用错误码枚举。考虑添加新的错误的情况。代替的办法是使用异常，因为异常可以派生子类。
16，避免重复代码！重复可能是软件中一切邪恶的根源！
17，如何写出以上的代码：从简陋的初稿开始打磨到最终完善。没有人可以从一开始就写出符合所有规则的函数！

写好函数的规范小结

标签：

原文地址：http://my.oschina.net/Bruce370/blog/530655

踩

(0)

评论一句话评论（0）

分享档案

更多>

2021年07月29日 (22)
2021年07月28日 (40)
2021年07月27日 (32)
2021年07月26日 (79)
2021年07月23日 (29)
2021年07月22日 (30)
2021年07月21日 (42)
2021年07月20日 (16)
2021年07月19日 (90)
2021年07月16日 (35)

周排行