Java开发规范[001]

《Java开发规范[001]》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、Java开发规范1概述为了使代码清晰易懂，使别的程序员能够容易理解代码所进行的实际工作，因此建立代码编写规范，形成开发小组编码约定，提高程序的可靠性、可读性、可修改性、可维护性、可继承性和一致性，不但可以保证程序代码的质量，而且可以继承软件开发成果，充分利用资源，使开发人员之间的工作成果可以共享。说明：该规范中蓝色斜体部分需要各项目小组制定开发规范的时候具体定制。具体定制请删除蓝色斜体部分。2开发环境规范项目统一使用UTF-8编码。[任何《开发规范文档》中必须统一规定JDK、应用服务器、数据库、开发工具，和它们的具体版本号(包括小版本号)。]名称版本号JDK

2、sunjdk1.5.0.11应用服务器tomcat5.5.25数据库oracle11g开发工具redhatdevloperstudiobeta23后台编码规范3.1变量命名规范l第一个字母小写，之后每个单词间的首字母大写。例如：userName，password等l静态常量字段（staticfinal）全部采用大写字母，单词之间用下划线分隔。例如：MIN_BALANCE,DEFAULT_DATEl避免使用下划线（除静态常量等）l避免使用类似的名字，或者仅仅是大小写不同的名字l如果变量是集合，则变量名应用复数。例如：int[]students;1.1函数命名规

3、范l函数名称第一个字母小写，之后每个单词间的首字母大写。例如：publicUserinfogetUserByName(StringuserName)和业务相关的函数命名方式，请参见“业务逻辑层编码规范”“DAO层编码规范”。1.2类命名规范l类首字母必须大写，每个单词的首字母也必须大写。lManagedBean、Service、DAO命名规则名称命名规则ManageBeanXXXManagedBeanServiceXXXServiceDAOXXXDAO注：XXX是需根据实际业务替换的名称l其他类可以根据需要自行命名1.3包定义规范1.3.1包命名规范l包名必

4、须小写。l命名方式：com.globalzt.项目名称.模块名(.次级模块...).层名1.1.1包规划名称包路径请求处理层com.globalzt.项目名称.模块名(.次级模块...).view业务逻辑层com.globalzt.项目名称.模块名(.次级模块...).serviceDAO层com.globalzt.项目名称.模块名(.次级模块...).daomodel路径com.globalzt.项目名称.common.model和业务有关的公共的部分com.globalzt.项目名称.common和业务无关的公共的部分com.globalzt.frame

5、work.common和业务有关的工具包com.globalzt.项目名称.util和业务无关的工具包com.globalzt.framework.util1.2常量定义规范l所有常量遵循“变量编码规范”中的常量部分的定义。l如果该常量只与自己类相关，则定义到自己类里面。例如：publicfinalclassjava.util.Localeimplementsjava.lang.Cloneable,java.io.Serializable{publicstaticfinaljava.util.LocaleENGLISH;publicstaticfinalja

6、va.util.LocaleFRENCH;publicstaticfinaljava.util.LocaleGERMAN;……}注：此例使用了java.util.Locale类的常量定义l其他常量定义到com.globalzt.项目名称.common.Constants里，按照不同分类，添加进自己的内部类里面。例如：publicclassConstants{publicstaticclassCommon{publicstaticfinalStringUSER_INFORMATION=""USER_INFORMATION"";}}1.1注释规范1.1.1类注释

7、格式如下：/***类的说明*Copyright(c)2008*公司名称*@author作者时间*@version1.0*/示例：/***用户登录类*@author唐杰2008-07-24*@version1.0*/1.1.2函数注释l注释格式/***函数功能解释*@param参数名称1参数解释*@param参数名称2参数解释*@return返回值解释*创建者创建时间*修改者修改时间修改内容*/示例：/***根据用户名查询一个用户*@paramuserName用户名称*@return用户对象*唐杰2008-07-23*何刚修改2008-07-24增加MD5加密

8、算法*/l除了属性的get、set函数外，其他函数必