论坛首页 Java企业应用论坛

一个应该忏悔的代码片段

浏览 20803 次
精华帖 (0) :: 良好帖 (13) :: 新手帖 (0) :: 隐藏帖 (0)
作者 正文
   发表时间:2009-04-23   最后修改:2009-04-23
请看下面这段代码:

// append every msisdn string in msisdnArray to target list file
			for (int i = 0; i < msisdnArray.length; i++) {

				//disable the function of check the duplicated MSISDN in target list
			//	if (!this.existInTodayFile(msisdnArray[i])) {

					this.addMsisdnToCache(msisdnArray[i]);
					writer.write(msisdnArray[i] + "\r\n");
					log.debug("The MSISDN: " + msisdnArray[i] + " was add to TargetList file successfully!");
			//	}
			} // end of for


这段代码不是我写的,不过整个项目基本上是我设计的,现在这个项目需要维护,existInTodayFile这个函数是检查文件中MSISDN是否已经存在,今天一个维护的同事问我为什么要把这行注释掉,我依稀记得注释掉这行代码的决定是我做的,但时至今日,我已经根本想不起来为什么要把这一行注释掉了。
   发表时间:2009-04-23   最后修改:2009-04-23
很可能是
当时msisdn里面没数据
又懒的加测试用数据.
还想要把这个程序页面展现出来

这一般是不作测试用例常见的问题
0 请登录后投票
   发表时间:2009-04-23   最后修改:2009-04-23
this.addMsisdnToCache(msisdnArray[i]);  我不知道你这是不是一个缓存, 如果是,说实话我很害怕别人写这种代码.因为我无法保证msisdnArray这个东西 外部调用的时候会不会进行重新赋值,如果会 那么我加到缓存里面的都是最后一次的外部赋值.所以建议msisdnArray里面的东西要实现克隆接口.
0 请登录后投票
   发表时间:2009-04-23  
this.addMsisdnToCache(msisdnArray[i])是把msisdn加到缓存里面,msisdnArray创建了以后就不变了。我想的是以后像这种注释的代码最好直接删掉,否则一定要加注释说明为什么
0 请登录后投票
   发表时间:2009-04-24  
cvs提交时不加comment么?
0 请登录后投票
   发表时间:2009-04-24  
daquan198163 写道
cvs提交时不加comment么?

不一定是cvs撒  反正lz找不到comments了
---------------

这个地方记下来,想起来或是测出问题再说。
0 请登录后投票
   发表时间:2009-04-24   最后修改:2009-04-24
kimmking 写道
daquan198163 写道
cvs提交时不加comment么?

不一定是cvs撒  反正lz找不到comments了
---------------

这个地方记下来,想起来或是测出问题再说。

当然不一定是cvs,但终究要用一种版本控制系统吧,每次提交时写些comment标明本次修改的意图,
然后出现楼主这种情况时只要查看资源历史记录就一目了然了,eclipse、fisheye都支持得很好,可以精确定位到代码行。例如:
https://fisheye.springsource.org/browse/springframework/trunk/src/org/springframework/aop/support/JdkRegexpMethodPointcut.java?r=17120
https://fisheye.springsource.org/browse/springframework/trunk/src/org/springframework/aop/support/JdkRegexpMethodPointcut.java?r1=13709&r2=17120
0 请登录后投票
   发表时间:2009-04-24  
daquan198163 写道
kimmking 写道
daquan198163 写道
cvs提交时不加comment么?

不一定是cvs撒  反正lz找不到comments了
---------------

这个地方记下来,想起来或是测出问题再说。

当然不一定是cvs,但终究要用一种版本控制系统吧,每次提交时写些comment标明本次修改的意图,
然后出现楼主这种情况时只要查看资源历史记录就一目了然了,eclipse、fisheye都支持得很好,可以精确定位到代码行。例如:
https://fisheye.springsource.org/browse/springframework/trunk/src/org/springframework/aop/support/JdkRegexpMethodPointcut.java?r=17120
https://fisheye.springsource.org/browse/springframework/trunk/src/org/springframework/aop/support/JdkRegexpMethodPointcut.java?r1=13709&r2=17120

我就是提交时都不写comments的人~
0 请登录后投票
   发表时间:2009-04-24  
是啊,很多人提交都不加comments的
0 请登录后投票
   发表时间:2009-04-24  
一般不加comment的,提交的内容应该被打回。
如果提交的东西导致编译失败的,应该被打回。

楼主的这段代码,代码中没有明显的说明注释原因,注释者,注释时间。
提交的时候也不加任何说明,当属被打回之列。
0 请登录后投票
论坛首页 Java企业应用版

跳转论坛:
Global site tag (gtag.js) - Google Analytics