java代码规范模板

《java代码规范模板》由会员上传分享，免费在线阅读，更多相关内容在学术论文-天天文库。

1、InfoDMSjava代码开发模板作者：周清江发布日期：2007-11-23当前版本：0.1上海英孚思为信息科技有限公司修订历史纪录代码开发环境修订InfoDMS英孚思为机密文件第9页共9页*A–追加M–修改D–删除版本改版日期改版说明作者评审V0.12007-11-23Akevin代码开发环境修订InfoDMS英孚思为机密文件第9页共9页Java开发模板文件导入1．导入统一的版权信息和类、方法、字段注释格式文件第一步打开Preference,选中code_style->>Code_Templates第二步选择Import…文件名：code_style_templates

2、.xml代码开发环境修订InfoDMS英孚思为机密文件第9页共9页1．导入统一代码样式文件第一步打开Preference,选中code_style->>Fromatter代码开发环境修订InfoDMS英孚思为机密文件第9页共9页第二步选择Import…文件名：code_style_formatter.xml代码开发环境修订InfoDMS英孚思为机密文件第9页共9页FileDescript统一定义导入统一的版权信息以后当新建每个JAVA以后，JAVA文件头内容统一为：/***Copyright(c)2006-2008OEMInfoserviceCorp.2006-2008,

3、AllRightsReserved.*ThissoftwareispublishedundertheInfoserviceDMSServiceInnerSolutionTeam.*Licenseversion1.0,acopyofwhichhasbeenincludedwiththis*distributionintheLICENSE.txtfile.**@Filename:com.infoservice.dms.service.bizbase.actions.MaintainBrand.java*@Createon:2007-9-30*@Author:kevin**@C

4、hangeList*---------------------------------------------------*NODateEditorChangeReasons*1.2007-9-30kevinAdd**/注意：1.如果文件不是新建而是从原来的项目中拷贝过来，请修改包名和类名.（@Filename:）com.infoservice.dms.service.bizbase.actions.MaintainBrand.java2.如果因为重要的业务逻辑而修改过文件，不要忘了在(@ChangeList)加上相关修改日期、修改人和简单描述修改原因。ClassBody

5、(Action)描述内容在一些业务比较简单的Action文件中ClassBody内容没有设置，这样生成的JAVADOC文档中这些Action就很难读懂。对于业务相对简单的Action也需对该业务内容做简单的描述，如下:代码开发环境修订InfoDMS英孚思为机密文件第9页共9页/****业务描述：新增、修改、删除发票类型**@authorkevin*@date2007-10-9下午02:58:17**/publicclassMaintainInvoiceTypeextendsActionImpl{protectedintperformExecute(ActionContex

6、tactionContext){try{//取得新增、修改状态参数String[]status=(String[])actionContext.getArrayValue("TM_INVOICE_TYPE.UPDATE_STATUS");…注意：1.由于文件新建时不会自动产生上面的注释代码，此时可以输入“/**”加上回车就会出现注释模板，再在业务描述中描述此方法的功能。2.如果方法内有复杂的业务逻辑，要多用“//取得新增、修改状态参数”这样的注释，以增强代码的可读性。3．些注释同样应用于所有METHOD（除PO类），如FOFACTORY方法和COMMON下的一些工具类方法

7、。字段的描述对于一些有特定业务说明的字段要加以注释，比如常量类的，数据字典还有状态等。/***描述：加锁错误*/publicstaticfinalStringMSG_ERROR_LOCK="MSG_ERROR_LOCK";异常的处理代码开发环境修订InfoDMS英孚思为机密文件第9页共9页1.CVS提交Comment内容填写在进行代码提交时，对要提交的代码进行简要的描述；描述当前提交的代码与仓库中的代码区别及修改理由。代码开发环境修订InfoDMS英孚思为机密文件第9页共9页代码开发环境修订InfoDMS英孚思为机密文件第9页