JAVA技术开发标准.docx
《JAVA技术开发标准.docx》由会员分享，可在线阅读，更多相关《JAVA技术开发标准.docx（8页珍藏版）》请在冰豆网上搜索。
JAVA技术开发标准
JAVA技术开发标准注释应该增加代码的清晰度，注释出谁在什么时候什么缘故做了一些事，而不仅仅是做了什么。
尽量使用javadoc标志，为类生成文档。
Java中有三种注释方法：
单行注释符（//）,块注释符（/*/）和文档注
释（/***/）
单行注释符（//）
//注释符用来对一行代码添加讲明型描述，常见使用如下：
变量注释，对变量的定义做出讲明，不同的行之间要对齐,如下
intlevel;//indentationlevel
intsize;//sizeoftable
添加在一行代码结尾或一段代码开始用于对代码进行描述
if（foo>1）{
//Doadouble-flip.
}
else{
returnfalse;//Explainwhyhere.
}
块注释符（/**/）
用于注释一段代码或添加多行讲明，如：
/*
*Hereisablockcomment.
*Commentcontinues…
*如果该文件不是修改人创建的，还需要添加修改人，时刻等信息
*/
文档注释（/***/）
文档注释使用/**开头，在使用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{}
方法注释
/**
*查询续期应收费用列表:
查询指定保单号码保单的续期应收费用信息，
*如果是修改，还应注明修改人及修改时刻
*@paramsPolicyCode保单号码
*@returnCollectionofRenewChargeVO应收费用信息列表
*@throwsException所有发生可能的专门
*/
publicCollectiongetRenewChargeList（StringsPolicyCode）throwsE
xception;
注释开始是对方法的描述。
Param是对参数的描述，return是返回类型的描述,throws是对抛出专门的描述。
严格按照文档注释的规范写出完整的注释后，程序生成的HTML类库指南就专门详细，方便其他使用该类的程序员查阅和使用。
二）BEANS定义规范
1、字段名称的取法符合规范，详细情形以数据字典为准，一样采纳英文去掉元音后的三字母简写，例如，code,简写cde;name简写nme;d
epartment简写dpt;年月简写ptyear,ptmnth金额简写orgamt,occamt,accamt;日期简写ptdate,occdat,effdat,strdat,endat等。
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（colu
mnNames={"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、每个定段必须要用行注释“//”的形式来讲明字段的意义，每行注释必须对齐，讲明必须清晰，如果该字段内容来自于Sysltem,贝懦在注
释中讲明ITEMID键值等。
6、在定义中，我们使用的类型仅为String、Double、lnteger、Date、Long型，不使用其它类型（在保险有关的项目中，所有的日期型均使用Date型，其它类型项目使用Long型）。
（三）JSP或HTML页面规范
下拉列表需要使用