首页 诗词 字典 板报 句子 名言 友答 励志 学校 网站地图
当前位置: 首页 > 教程频道 > 软件管理 > 软件架构设计 >

代码设计进程中的常见缺陷

2013-11-08 
代码设计过程中的常见缺陷最近review同事的代码发现很多常见的缺陷,总结自己代码遇到过的问题,写了以下十

代码设计过程中的常见缺陷

最近review同事的代码发现很多常见的缺陷,总结自己代码遇到过的问题,写了以下十点:

?

1、代码缺少注释;硬编码、常量没有说明含义。这是代码中常见的小问题。
?? 源文件前面没有概要介绍,包括作者,时间,功能说明等。
??
2、在java代码中建议使用模板类List<string>代替非模板类Array。
?? 因为使用List<string>可以知道list里面的类型,而直接使用非模板类Arraylist不知道里面的类型。

?? HashMap和HashSet类似。

?

3、大段代码应分成多个函数。
?? 当内部类体积较大的时候,建议重新创建一个文件。
?? 可以增加可读性;方便单元测试

?

4、当逻辑比较复杂的时候,需要根据逻辑把代码分在一个或者几个class中。

?

5、当要判断函数返回的错误值,最好返回int值,并且每个错误返回的值都不同。可以从-1开始设置。
?? log输出的时候,任何两个log输出都不应该相同,防止无法分清是哪个地方出错。

?

6、没有使用恰当的设计模式,使得程序比较复杂。
?? 例如:对应1.0和2.0两种数据,可以使用一个基类,两个派生类的来实现。
?? 花时间了解各种设计模式是值得的。
??

7、多个shell脚本,配置的参数没有集中在一个文件或者多个配置文件中。
?? 否则修改起来比较麻烦。

?

8、数据结构不合适,导致效率不高。
?? 比如应该用set的时候用hash。
?? 应该用二分查找的时候用遍历。
??
9、参数传递时,应该传引用的时候传值。尽量减少构造新的对象。

?

10、尽量减少运算的次数。
??? 哪位大师说的:提高运行效率就是“空间换时间”;减少内存就是“空间换时间”
??? 比如一个程序中经常计算整数1到1000的对数值,那么应该事先计算好所有的值,每次用的时候查表就可以了。

1 楼 poson 2009-06-25   我看了《重构》的第一章,想说:关于代码review和重构的事情,还是看这本书上时怎么说的吧。

热点排行