Java注释示例一

《Java注释示例一》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、Java注释示例一关键字：Java程序设计注释示例技巧原则序言世界级软件大师KentBeck(大名鼎鼎的JUnit作者)在其著作ImplementationPatterns中指出”Programsarereadmoreoftenthantheyarewritten.”大意是“代码被阅读的时间远比写出来的时间要多得多”。好的注释能够帮助代码阅读者了解设计者思路，便于代码的维护和扩展。以下示例是从一些开源框架中摘录的代码片段，供有志于编写可阅读代码的开发人员参考。1.解释为什么，而非是什么以下代码解释了月份减一和加一的原因，非常简洁明了。publicintgetMonth(){returnnor

2、malize().getMonth()-1;//adjust1-basedto0-based}publicvoidsetMonth(intmonth){inty=0;if(month>=12){y=month/12;month%=12;}elseif(month<0){y=CalendarUtils.floorDivide(month,12);month=CalendarUtils.mod(month,12);}BaseCalendar.Dated=getCalendarDate();if(y!=0){d.setNormalizedYear(d.getNormalizedYear()+y);

3、}d.setMonth(month+1);//adjust0-basedto1-basedmonthnumbering}2.增强变量含义说明以下代码对变量doc作了增强说明，该注释表明代码是将文档是从2.0版本转换为3.0版本。//Convertfrom2.0to3.0PDL4Documentdoc30=convert(doc);1.给代码划分段落如果一个方法的实现比较复杂，可以通过注释分段解释功能。如以下代码分为三个阶段，一个阶段用一段注释加以阐述。通常更好的做法是将一个复杂的方法重构为多个功能明确的方法。publicvoidexecute(ExecutionContextexecutio

4、nContext){Tokentoken=executionContext.getToken();//phaseone:collectallthetransitionNamesCollectiontransitionNames=null;ListforkedTokens=newArrayList();//bydefault,theforkspawnsatokenforeachleavingtransitionif(script==null){transitionNames=getLeavingTransitionsMap().keySet();}else{//ascriptisspecifi

5、ed//ifascriptisspecified,usethatscripttocalculatetheset//ofleavingtransitionstobeusedforforkingtokens.MapoutputMap=null;try{outputMap=script.eval(token);}catch(Exceptione){this.raiseException(e,executionContext);}if(outputMap.size()==1){Objectresult=outputMap.values().iterator().next();if(resultins

6、tanceofCollection){transitionNames=(Collection)result;}}if(transitionNames==null){thrownewJbpmException("scriptforfork'"+name+"'shouldproduceonecollection(inonewritablevariable):"+transitionNames);}}//phasetwo:createforkedtokensforthecollectedtransitionnamesIteratoriter=transitionNames.iterator();w

7、hile(iter.hasNext()){4StringtransitionName=(String)iter.next();forkedTokens.add(createForkedToken(token,transitionName));}//phasethree:launchchildtokensfromtheforkoverthegiventransitionsiter=forkedTokens.it