代码整洁之道 函数
2015-11-19 11:03
225 查看
学习代码整洁之道,尽量提高代码的可读性。
对于函数的要求:
1、20行以内,缩进小于3层。
2、只做一件事情。
3、涉及的事情,要保持在一个抽象层级。
4、switch语句,要考虑是否可以用多态代替,对修改关闭,对扩展开放。
5、函数名使用描述性的名称,不要用简写,现在的编译器支持很长的字符串,用好动词与关键字。
经常出现的情况是:
1、函数很长,影响阅读。
2、处理多个事情,逻辑复杂,违反“单一权责”。
3、违反“开闭原则”。
4、函数名简写,意思不明确。
关于函数输入参数:(从简单到复杂的情况)
1、一元参数
2、二元参数
3、三元参数
参数越多,情况就越复杂,可以想象单元测试所需要的样本量与参数个数的关系。
标示参数:即输入参数为布尔型,光明正大的告诉别人,这个函数不只处理一个事情。
不要将输入参数,用作输出用途,譬如byte[],会引起理解上的混乱。
关于错误处理:
1、使用异常替代返回错误码,代码会变得简洁。
2、错误处理就是一件事。
3、对于新异常,可使用异常类派生的方法实现。
不要重复自己,即不要存在两份相同的代码片段。
完美的代码不是一开始就写成的,开始的代码都冗长而复杂,通过以下步骤:
1、分解函数。
2、修改名称。
3、消除重复。
这其中涉及缩短和重新安置方法,拆散类。在多次循环后,代码更趋向于完美。
对于函数的要求:
1、20行以内,缩进小于3层。
2、只做一件事情。
3、涉及的事情,要保持在一个抽象层级。
4、switch语句,要考虑是否可以用多态代替,对修改关闭,对扩展开放。
5、函数名使用描述性的名称,不要用简写,现在的编译器支持很长的字符串,用好动词与关键字。
经常出现的情况是:
1、函数很长,影响阅读。
2、处理多个事情,逻辑复杂,违反“单一权责”。
3、违反“开闭原则”。
4、函数名简写,意思不明确。
关于函数输入参数:(从简单到复杂的情况)
1、一元参数
2、二元参数
3、三元参数
参数越多,情况就越复杂,可以想象单元测试所需要的样本量与参数个数的关系。
标示参数:即输入参数为布尔型,光明正大的告诉别人,这个函数不只处理一个事情。
不要将输入参数,用作输出用途,譬如byte[],会引起理解上的混乱。
关于错误处理:
1、使用异常替代返回错误码,代码会变得简洁。
2、错误处理就是一件事。
3、对于新异常,可使用异常类派生的方法实现。
不要重复自己,即不要存在两份相同的代码片段。
完美的代码不是一开始就写成的,开始的代码都冗长而复杂,通过以下步骤:
1、分解函数。
2、修改名称。
3、消除重复。
这其中涉及缩短和重新安置方法,拆散类。在多次循环后,代码更趋向于完美。
相关文章推荐
- Ⅰ.2.6.8 如何测试QTable (Qt 3)
- Java 小例子:按照顺时针或逆时针方向输出一个数字矩阵
- java clone
- 解决MyEclipse中的Building workspace问题的三个方法
- iOS libc++abi.dylib: terminate_handler unexpectedly threw an exception
- Python生成器generator之next和send运行流程
- C++笔记总结之关于数组的引用和引用的数组
- JDK、JRE、JVM三者间的关系
- PHP xdebug的安装
- 64位操作系统弹出"Failed to load the JNI shared library “E:/2000/Java/JDK6/bin/..jre/bin/client/jvm.dll”
- spring-aop示例
- ASP.NET MVC- Area 使用
- SSH:Struts1框架(MVC讲解)
- Python-安装模块
- JAVA和c++区别整理
- c# 取本地ip地址
- java 入门 第三季1
- Java设计模式之观察者模式
- [PAT]PAT使用Java解题时的注意点
- C# xml读取操作