敏捷开发中如何将注释转换为代码
http://tech.ddvip.com 2008年01月22日 社区交流
内容摘要:本文讲述了敏捷开发中将注释转换为代码的必要性,需要注意的问题和具体的实例源代码,供大家参考!
public class ParticipantInfoOnBadge {
...
//***********************
//构造函数
//从数据库取出该参会者信息
//***********************
ParticipantInfoOnBadge(String participantId) {
this.participantId = participantId;
...
}
}
将注释转换为方法的一部分
上面的构造函数中有两句注释,第一句我们已经解决了,那么还有“从数据库取出该参会者信息”如何处理呢?这句注释描述了该构造函数如何实现,即从数据库取出信息。我们可以将这句话转化为:
public class ParticipantInfoOnBadge {
...
//***********************
//构造函数
//***********************
ParticipantInfoOnBadge(String participantId) {
loadInfoFromDB(participantId); //现在看一下这个构造函数内部,
我们就能知道这个构造函数是做什么的了
}
void loadInfoFromDB(String participantId) {
this.participantId = participantId;
...
}
}
删掉没用的注释
有时候,我们会碰到一些注释,很明显没什么用处的,比如:
public class ParticipantInfoOnBadge {
...
//***********************
//构造函数
//***********************
ParticipantInfoOnBadge(String participantId) {
...
}
}
就算去掉这些注释,我们也能看出来这是一个构造函数。这个注释并没什么用处。
什么样的类是看代码的人最喜欢的?那就是简单易看的类。一个设计得好的类,能够让人一眼看出这个类都有些什么东西,明白这个类都做了什么事请。如果看这个类时,要不停地将屏幕滚来滚去,思维还要随屏幕的滚动跳转,无形中看懂这个类需要花的时间就多了。
作者:王伟杰 责编:豆豆技术应用