代码整洁之道 函数

来源:互联网 发布:皮书包知乎 编辑:程序博客网 时间:2024/06/05 07:14

学习代码整洁之道,尽量提高代码的可读性。

对于函数的要求:

1、20行以内,缩进小于3层。

2、只做一件事情。

3、涉及的事情,要保持在一个抽象层级。

4、switch语句,要考虑是否可以用多态代替,对修改关闭,对扩展开放。

5、函数名使用描述性的名称,不要用简写,现在的编译器支持很长的字符串,用好动词与关键字。

经常出现的情况是:

1、函数很长,影响阅读。

2、处理多个事情,逻辑复杂,违反“单一权责”。

3、违反“开闭原则”。

4、函数名简写,意思不明确。


关于函数输入参数:(从简单到复杂的情况)

1、一元参数

2、二元参数

3、三元参数

参数越多,情况就越复杂,可以想象单元测试所需要的样本量与参数个数的关系。

标示参数:即输入参数为布尔型,光明正大的告诉别人,这个函数不只处理一个事情。

不要将输入参数,用作输出用途,譬如byte[],会引起理解上的混乱。


关于错误处理:

1、使用异常替代返回错误码,代码会变得简洁。

2、错误处理就是一件事。

3、对于新异常,可使用异常类派生的方法实现。


不要重复自己,即不要存在两份相同的代码片段。


完美的代码不是一开始就写成的,开始的代码都冗长而复杂,通过以下步骤:

1、分解函数。

2、修改名称。

3、消除重复。

这其中涉及缩短和重新安置方法,拆散类。在多次循环后,代码更趋向于完美。








0 0
原创粉丝点击