Java开发规范.doc

概述为了使代码清晰易懂,使别的程序员能够容易理解代码所进行的实际工作,因此建立代码编写规范,形成开发小组编码约定,提高程序的可靠性、可读性、可修改性、可维护性、可继承性和一致性,不但可以保证程序代码的质量,而且可以继承软件开发成果,充分利用资源,使开发人员之间的工作成果可以共享。说明:该规范中蓝色斜体部分需要各项目小组制定开发规范的时候具体定制。具体定制请删除蓝色斜体部分。开发环境规范项目统一使用UTF-8编码。[任何《开发规范文档》中必须统一规定JDK、应用服务器、数据库、开发工具,和它们的具体版本号(包括小版本号)。] ,之后每个单词间的首字母大写。例如: userName,password等 静态常量字段(staticfinal)全部采用大写字母,单词之间用下划线分隔。例如: MIN_BALANCE,DEFAULT_DATE避免使用下划线(除静态常量等) 避免使用类似的名字,或者仅仅是大小写不同的名字如果变量是集合,则变量名应用复数。例如: int[]students;函数命名规范函数名称第一个字母小写,之后每个单词间的首字母大写。例如: publicUserinfogetUserByName(StringuserName)和业务相关的函数命名方式,请参见“业务逻辑层编码规范”“DAO层编码规范”。类命名规范类首字母必须大写,每个单词的首字母也必须大写。ManagedBean、Service、DAO命名规则名称命名规则ManageBeanXXXManagedBeanServiceXXXServiceDAOXXXDAO 注:XXX是需根据实际业务替换的名称 其他类可以根据需要自行命名 包定义规范包命名规范包名必须小写。 .(.次级模块...).层名 .(.次级模块...)..(.次级模块...)..(.次级模块...)....globalzt..globalzt....“变量编码规范”中的常量部分的定义。如果该常量只与自己类相关,则定义到自己类里面。例如: ,{;;;……} 注:,按照不同分类,添加进自己的内部类里面。例如: lassConstants{mon{publicstaticfinalStringUSER_INFORMATION=""USER_INFORMATION"";}}注释规范类注释格式如下:/***类的说明*Copyright(c)2008*公司名称****@author作者时间****@*/ 示例:/***用户登录类****@author唐杰2008-07-24****@*/ 函数注释注释格式/***函数功能解释****@param参数名称1参数解释****@param参数名称2参数解释****@return返回值解释*创建者创建时间*修改者修改时间修改内容*/示例: /***根据用户名查询一个用户****@paramuserName用户名称****@return用户对象*唐杰2008-07-23*何刚修改2008-07-24增加MD5加密算法*/除了属性的get、set函数外,其他函数必须加上注释,注释里必须标明作者、修改者以及时间变量注释变量的注释使用//,并写在变量申明的上方或者后方。例如: //用户名privateStringuserName; 程序代码片断注释程序代码段的注释可以使用/**/和//两种形式,请自行选择。例如: //获取user服务UserServiceus=(UserService)(""userService""); 修改程序代码的注释 修改别人的代码或者在别人函数里新增代码,需要在自己新增或修改的的代码前加上注释,规范如下