不要保留无用的代码
作者: 黑咖啡, 出处:IT专家网, 责任编辑: 李春禹,
2007-12-28 08:39
与那些不再使用的代码一样,冗余的代码同样造成可读性下降。就是执行了也没有什么效果,或者是那些同一件事情反复执行的,都是属于冗余的。在编写代码时,时刻都要想着,这段代码是不是冗余的。说到底,还是应该删除那些不用的代码和冗余的代码。
说明:保留无用的代码,会造成代码越来越难懂,应该避免。这不仅仅是为了别人,也是为了未来的自己。那些不用的代码,或者是以后不再用的方法,参数,变量,标签等等,究竟是忘了删除呢,还是为了以后预留的呢,慢慢谁也不知道了,自然代码也越来越难读懂了。应该使用版本管理工具,从最新版上把这类代码删除。如果这做不到,比如说在开发过程中想要暂时保留,也应该按照项目的规约明确的标注出来。与那些不再使用的代码一样,冗余的代码同样造成可读性下降。就是执行了也没有什么效果,或者是那些同一件事情反复执行的,都是属于冗余的。冗余代码,往往让人费解,到底为什么要这么写呢?在编写代码时,时刻都要想着,这段代码是不是冗余的。

例 留下了不用的代码
| Public class BadSample { public static void main (StriERROR[] args) { usedMethod(); } private static void usedMethod() { } /* 不再用的方法 */ private static void unusedMethod() { //ERROR:为什么留在这里呢,从注释上根本看//不出来 } } |
一般来说,有如下一些支持留下不用的代码的理由
(a)对要修正的内容没有确信,希望把原来的代码留在哪里。
(b)觉得留在那里将来可能有用。
(c)其他。忘了删除,或者是觉得删除别人的代码不太好等等。
对于(a),应该通过使用版本管理工具来解决。
对于(b),理应通过文档来解决。
对于(c)的忘记删除的问题,可以利用静态解析等工具来进行检查。
代码的存续时间,与其说是开发的期间长,不如说是维护的期间更长。不仅仅是为了开发期间,更是为了将来不要破坏可维护性,需要尽力保持代码的整洁。另外,在对内存使用有严格要求的系统中,还会引起不用的代码无端消耗资源从而导致性能下降的问题。说到底,还是应该删除那些不用的代码和冗余的代码。
- 本文关键词:

