敏捷开发中如何将注释转换为代码
http://tech.ddvip.com 2008年01月22日 社区交流
内容摘要:本文讲述了敏捷开发中将注释转换为代码的必要性,需要注意的问题和具体的实例源代码,供大家参考!
一个屏幕,差不多只能显示20行左右的代码,而这个没用的注释一下子就占用了3行代码,一些有用的信息反而被挤掉(比如代码),得不偿失。还是赶紧移除这个注释吧!
public class ParticipantInfoOnBadge {
...
ParticipantInfoOnBadge(String participantId) {
...
}
}
用方法名来表达注释
还可以将一部分代码重构成方法,用方法名来表达注释的意思。先看看下面这个注释:
void loadInfoFromDB(String participantId) {
this.participantId = participantId;
//***********************
//取得参会者的全名
//***********************
ParticipantsInDB partsInDB = ParticipantsInDB.getInstance();
Participant part = partsInDB.locateParticipant(participantId);
if (part != null) {
//取得参会者的英文全名
engFullName = part.getELastName() + ", " + part.getEFirstName();
//取得参会者的中文全名
chiFullName = part.getCLastName()+part.getCFirstName();
//***********************
//取得参会者所在部门和国家
//***********************
OrganizationsInDB orgsInDB = OrganizationsInDB.getInstance();
//取得参会者被雇佣部门的ID
String oid = orgsInDB.getOrganization(participantId);
if (oid != null) {
Organization org = orgsInDB.locateOrganization(oid);
engOrgName = org.getEName();
chiOrgName = org.getCName();
engOrgCountry = org.getEAddress().getCountry();
chiOrgCountry = org.getCAddress().getCountry();
}
}
}
现在我们已经看清这段注释要表达一些什么信息。要使代码跟注释一样清楚,我们可以将注释所解释的那一部分代码抽取出来做成一个方法,然后让方法名来表达注释的意思。如果可以的话,我们就不需要额外的注释了。
作者:王伟杰 责编:豆豆技术应用