Java开发规返亩.docVIP

Java开发规范 概述 为了使代码清晰易懂，使别的程序员能够容易理解代码所进行的实际工作建立代码编写规范，形成开发小组编码约定提高程序的可靠性、可读性、可修改性、可维护性、可继承性和一致性可以保证程序代码的质量，继承软件开发成果，充分利用资源，使开发人员之间的工作成果可以共享。1 应用服务器 tomcat 5.5.25 数据库 oracle 11g 开发工具 red hat devloper studio beta2 后台编码规范 变量命名规范 第一个字母小写，之后每个单词间的首字母大写。 例如： userName，password等 静态常量字段（static final） 全部采用大写字母，单词之间用下划线分隔。 例如： MIN_BALANCE, DEFAULT_DATE 避免使用下划线（除静态常量等） 避免使用类似的名字，或者仅仅是大小写不同的名字 如果变量是集合，则变量名应用复数。 例如： int[] students; 函数命名规范 函数名称第一个字母小写，之后每个单词间的首字母大写。 例如： public Userinfo getUserByName(String userName) 和业务相关的函数命名方式，请参见“业务逻辑层编码规范”“DAO层编码规范”。 类命名规范 类首字母必须大写，每个单词的首字母也必须大写。 ManagedBean、Service、DAO命名规则 名称 命名规则 Manage Bean XXXManagedBean Service XXXService DAO XXXDAO 注：XXX是需根据实际业务替换的名称 其他类可以根据需要自行命名 包定义规范 包命名规范 包名必须小写。 命名方式：com.globalzt.项目名称.模块名(.次级模块...).层名 包规划 名称 包路径 请求处理层 com.globalzt.项目名称.模块名(.次级模块...).view 业务逻辑层 com.globalzt.项目名称.模块名(.次级模块...).service DAO层 com.globalzt.项目名称.模块名(.次级模块...).dao model路径 com.globalzt.项目名称.common.model 和业务有关的公共的部分 com.globalzt.项目名称.common 和业务无关的公共的部分 mon 和业务有关的工具包 com.globalzt.项目名称.util 和业务无关的工具包 com.globalzt.framework.util 常量定义规范 所有常量遵循“变量编码规范”中的常量部分的定义。 如果该常量只与自己类相关，则定义到自己类里面。 例如： public final class java.util.Locale implements java.lang.Cloneable, java.io.Serializable { public static final java.util.Locale ENGLISH; public static final java.util.Locale FRENCH; public static final java.util.Locale GERMAN; …… } 注：此例使用了java.util.Locale类的常量定义 其他常量定义到com.globalzt.项目名称.common.Constants里，按照不同分类，添加进自己的内部类里面。 例如： public class Constants { public static class Common { public static final String USER_INFORMATION=USER_INFORMATION; } } 注释规范 类注释 格式如下： /** * 类的说明 * Copyright (c) 2008 * 公司名称 * @author 作者 时间 * @version 1.0 */ 示例： /** * 用户登录类 * @author 唐杰 2008-07-24 * @version 1.0 */ 函数注释 注释格式 /** * 函数功能解释 * @param 参数名称1 参数解释 * @param 参