坏代码,好代码

坏代码:
1.没有测试用例。
2.没有接口使用说明,没有参数说明,没有返回值说明,没有异常说明。
3.没有参数校验。
4.没有良好的异常处理机制,异常处理很随意。
5.想到什么写什么,编写过于随意。
6.没有准确的日志,调试日志,错误日志等等
7.一个方法的代码有臭又长。比如超过250行。


好代码:
1.测试用例充分,测试代码100%覆盖,至少包含正常用例,边界用例,异常用例三类测试。最好能做到持续集成。
2.方法的输入输出应该有详尽的说明,包括参数说明、类型、取值范围等等,返回值,可能的返回的异常
3.严格的参数校验是系统健壮性的保障之一。
4.异常应该统一规范化处理,不同的异常应该有不同的编号,尤其是在异构系统中。
5.简单的功能可以随即就写,但复杂的功能必须要有详尽的设计。明确系统的结构,比如是用类图,架构图,用例图等等。明确功能的流程,明确流程是最重要的,可以采用行为驱动、活动图、时序图等等来理清思路。了解系统静态结构和动态行为之后,设计和抽象轻易而举。
对你的每一行代码负责。
6.日志非常重要,比如开发是系统运行时的状态,出错时能准确定位。毕竟系统都是调试出来的。分析系统日志也是有很多用处,比如分析用户的行为,根据日志统计优化系统等等。
7.模块化是构建大系统最关键的任务之一。模块的功能限定必须非常明确,合理定义模块接口,尽可能做到面向需求、简单易用。合理划分模块,抽取公共模块、抽象更抽象的接口是设计的核心理念。

猜你喜欢

转载自uzoice.iteye.com/blog/2087291