（技术规范标准）JAVA技术开发标准.pdfVIP

（技术规范标准）JAVA 技 术开发标准 版本 1.3 页码： 1 / 7 （一）注释规则 注释应该增加代码的清晰度，注释出谁在什么时候为什么做了一些事，而不仅仅是做了 什么。尽量使用 javadoc 标志，为类生成文档。 Java 中有三种注释方法：单行注释符（// ），块注释符（/*/ ）和文档注释（/***/） （1） 单行注释符（// ） //注释符用来对一行代码添加说明型描述，常见使用如下： a. 变量注释，对变量的定义做出说明，不同的行之间要对齐,如下 intlevel;//indentationlevel intsize;//sizeoftable b. 添加在一行代码结尾或一段代码开始用于对代码进行描述 if(foo1){ //Doadouble-flip. ... } else{ returnfalse;//Explainwhyhere. } （2） 块注释符（/**/ ） 用于注释一段代码或添加多行说明，如： /* *Hereisablockcomment. *Commentcontinues… *如果该文件不是修改人创建的，还需要添加修改人，时间等信息 */ （3 ） 文档注释(/***/) 文档注释使用/**开头，在使用 javadoc 对 java 代码制作文当时会自动将代码中的 文档注释添加到文档中去。在所有 class 开头和每个方法前都应该加上/**…*/注释， 便于自动生成 html 格式的类库指南。（包括但不限于 beans,action,form,dao） 对于 class 的文档注释应该写在 class 申明语句前，并且拥有如下格式： /** *pTitle:续期收费请求对象/p *pDescription:封装页面提交的请求数据/p *pCopyright:Copyright(c)2002/p *pCompany:Co.,Ltd./p *@since2008-08-20 *@authorKevinQiu *@version1.0 */ publicclassRenewChargeRO{} （4 ） 方法注释 /** *查询续期应收费用列表:查询指定保单号码保单的续期应收费用信息， *如果是修改，还应注明修改人及修改时间BR *@paramsPolicyCode 保单号码 *@returnCollectionofRenewChargeVO 应收费用信息列表 *@throwsException 所有发生可能的异常 */ publicCollectiongetRenewChargeList(StringsPolicyCode)throwsException; 注释开始是对方法的描述。Param 是对参数的描述，return 是返回类型的描述,throws 是对抛出异常的描述。 严格按照文档注释的规范写出完整的注释后，程序生成的 HTML 类库指南就很详细，方 便其他使用该类的程序员查阅和使用。 （二）BEANS 定义规范 1 、字段名称的取法符合规范，详细情况以数据字典为准，一般采用英文去掉元音后的三字 母简写，例如，code ，简写cde ；name 简写 nme ；department 简写 dpt ；年月简写 ptyear,ptmnth,金 额 简 写 orgamt ， occamt,accamt ； 日 期 简 写 ptdate,occdat,effdat,strdat,endate 等。 2