(一)注释规则注释应该增加代码的清晰度,注释出谁在什么时候为什么做了一些事,而不仅仅是做了什么。尽量使用javadoc标志,为类生成文档。Java中有三种注释方法:单行注释符(//),块注释符(/*/)和文档注释(/***/)(1)单行注释符(//)//注释符用来对一行代码添加说明型描述,常见使用如下:a.变量注释,对变量的定义做出说明,不同的行之间要对齐,如下intlevel;//indentationlevelintsize;//sizeoftableb.添加在一行代码结尾或一段代码开始用于对代码进行描述if(foo>1){//Doadouble-flip....}else{returnfalse;//Explainwhyhere.}(2)块注释符(/**/)用于注释一段代码或添加多行说明,如:/**Hereisablockcomment.*Commentcontinues…*如果该文件不是修改人创建的,还需要添加修改人,时间等信息*/(3)文档注释(/***/)文档注释使用/**开头,在使用javadoc对java代码制作文当时会自动将代码中的文档注释添加到文档中去。在所有class开头和每个方法前都应该加上/**…*/注释,便于自动生成html格式的类库指南。(包括但不限于beans,action,form,dao)对于class的文档注释应该写在class申明语句前,并且拥有如下格式:/***
Title:续期收费请求对象
*
Description:封装页面提交的请求数据
*
Copyright:Copyright(c)2002
*
Company:Co.,Ltd.
*@since2008-08-20*@authorKevinQiu*@version1.0*/publicclassRenewChargeRO{}(4)方法注释/***查询续期应收费用列表:查询指定保单号码保单的续期应收费用信息,*如果是修改,还应注明修改人及修改时间
*@paramsPolicyCode保单号码*@returnCollectionofRenewChargeVO应收费用信息列表*@throwsException所有发生可能的异常*/publicCollectiongetRenewChargeList(StringsPolicyCode)throwsException;注释开始是对方法的描述。Param是对参数的描述,return是返回类型的描述,throws是对抛出异常的描述。严格按照文档注释的规范写出完整的注释后,程序生成的HTML类库指南就很详细,方便其他使用该类的程序员查阅和使用。第3页共8页编号:时间:2021年x月x日书山有路勤为径,学海无涯苦作舟页码:第3页共8页(二)BEANS定义规范1、字段名称的取法符合规范,详细情况以数据字典为准,一般采用英文去掉元音后的三字母简写,例如,code,简写cde;name简写nme;department简写dpt;年月简写ptyear,ptmnth,金额简写orgamt,occamt,accamt;日期简写ptdate,occdat,effdat,strdat,endate等。2、String类型必须定义适当的长度;Double、Float类型必须定义适当的长度及精度@Column(nullable=true,length=10),如果是长文档备注类型,直接定义为@Lob类型@Column(nullable=true,precision=14,scale=2)3、可以为列建唯一索引,如下所示@Column(nullable=true,length=15,unique=true)columnDefinition,为列设定默认值4、按适当的情况定义主键及复合索引等@Table(name="sys_clnt",uniqueConstraints={@UniqueConstraint(columnNames={"clntid","simpname"})})定义本Beans的主键,主键可以是Integer,String,Date等类型@Id@TableGenerator(name="SId",table="sysid",pkColumnName="id",valueColumnName="tableid",pkColumnValue="5",allocationSize=1,initialValue=10000000)@GeneratedValue(strategy=GenerationType.TABLE,generator="SId")@Column(nullable=false,length=10)privateStringusercode;5、每个定段必须要用行注释“//”的形式来说明字段的意义,每行注释必须对齐,说明必须清晰,如果该字段内容来自于SysItem,则需在注释中说明ITEMID键值等。6、在定义中,我们使用的类型仅为String、Double、Integer、Date、Long型,不使用其它类型(在保险相关的项目中,所有的日期型均使用Date型,其它类型项目使用Long型)。第4页共8页第3页共8页编号:时间:2021年x月x日书山有路勤为径,学海无涯苦作舟页码:第4页共8页(三)JSP或HTML页面规范1、下拉列表需要使用