敏捷开发中如何将注释转换为代码

http://tech.ddvip.com   2008年01月22日    社区交流

内容摘要:本文讲述了敏捷开发中将注释转换为代码的必要性,需要注意的问题和具体的实例源代码,供大家参考!

  我们先看一下第一个注释:

//存放参会者身上戴的牌子所显示的信息
public class Badge {
...
}

  我们为什么需要这个注释呢?因为程序员认为“Badge”这个类名不足以让读代码的人清楚这个类的作用,所以写了这个注释。如果我们直接将注释所表达的一些信息放在类名里面的话,就没有单独写注释的必要。比如:

public class ParticipantInfoOnBadge {
...
}

  其实很多人肯定会问难道写注释不是一个好的编程习惯吗?这问题很好,我也想知道。在解释之前,我们先把这个示例中所有的注释都转为代码看看。

  将注释转换为变量名

  比如:

public class ParticipantInfoOnBadge {
String pid; //参会者ID
String engName; //英文全名
String chiName; //中文全名
String engOrgName; //所在部门英文名称
String chiOrgName; //所在部门中文名称
String engCountry; //部门所在国家的中文名称
String chiCountry; //部门所在国家的英文名称
...
}

  这里,我们将对属性的注释转化为属性名。比如:

public class ParticipantInfoOnBadge {
String participantId;
String participantEngFullName;
String participantChiFullName;
String engOrgName;
String chiOrgName;
String engOrgCountry;
String chiOrgCountry;
...
}

  又如,可将对参数的注释转化为参数名:

public class ParticipantInfoOnBadge {
...
//***********************
//构造函数
//根据参会者ID,从数据库取出该参会者信息
//***********************
ParticipantInfoOnBadge(String pid) {
this.pid = pid;
...
}
}

  可以转化为:

作者:王伟杰    责编:豆豆技术应用

正在加载评论...