软件开发项目开发规范.docVIP

JAVA语言编程格式规范 软件研发中心XX项目组 2013．03 V1.0 目录 1. 前言 4 2. 试用范围 4 3. JAVA命名规范 4 3.1 公共约定 4 3.2 Java文件、包 4 3.3 类、接口命名规范 4 3.4 方法命名规范 4 3.5 常量 5 3.6 变量和参数 5 3.7 组件/部件 5 3.8 集合 5 3.9 神秘的数 6 3.10 其他 6 3.11 Java异常 6 3.12 数组命名 6 4. 书写格式规范 6 4.1 缩进 6 4.2 空格 6 4.3 对齐 6 4.4 空行 7 4.5 注释 7 5. 代码文件风格 7 5.1 文件生成 7 5.2 package/import 7 5.3 文件头部注释 7 5.4 存取方法 8 5.5 构造函数 9 5.6 克隆方法 9 5.7 类方法 9 5.8 main 方法 10 6. 开发框架约定 10 6.1 视图层编码约定： 10 6.2 控制层编码约定： 10 6.3 实体层编码约定： 10 6.4 服务层编码约定： 11 6.5 通用编码约定： 11 6.6 数据库约定： 11 前言 为确保系统源程序可读性，从而增强系统可维护性，兹制定下述编程规范，以规范系统各部分编程。系统继承的其它资源中的源程序也应按此规范作相应修改。 试用范围 本文档将作为广州诚泰交通机电工程有限公司研发中心XX项目系统软件（JAVA语言）开发的编程格式规范。在系统的编码、测试及维护过程中，要求严格遵守。 JAVA命名规范 公共约定 命名指系统中对源文件名、方法、目录、包、数据库表名、数据库字段等的命名。 系统所用的命名都使用英文缩写来表达。 命名的组成方式为：前缀+{命名词素缩写}，前缀表达出命名的用途，如数据库表等。 命名的前缀由项目组确定。 除系统公共维护对象外的其他对象，命名全部用小写。一种方式用“_”作连接符，另一种方式是词素的第一个字母大写直接连接在一起。在本规范中，数据库名、数据库字段名采用第一种方式，其余采用第二种方式。 使用可以准确说明变量/字段/类/接口/包等的完整的英文描述符。例如，采用类似firstName，listAllUsers或CorporateCustomer这样的名字，严禁使用汉语拼音及不相关单词命名，虽然Java支持Unicode命名，但本规范规定对包、类、接口、方法、变量、字段等不得使用汉字等进行命名 采用大小写混合，提高名字的可读性。一般应该采用小写字母，但是类和接口的名字的首字母，以及任何中间单词的首字母应该大写。包名全部小写。 尽量少用缩写，但如果一定要使用，当使用公共缩写和习惯缩写等，如实现（implement）可缩写成impl，经理（manager）可缩写成mgr等，具体参看下表，严禁滥用缩写。 避免使用长名字（最好不超过35个字母）。 避免使用数字，但可用2代替to，用4代替for等，如：go2Jsp。 Java文件、包 文件名当与其类严格相同，所有单词首字母大写。 包名一般以项目或模块名命名，少用缩写和长名，一律小写。 基本包：com.czpost，所有包、文件都从属于此包。 包名按如下规则组成： [基本包].[项目名].[模块名].[子模块名]... 如：com.czpost.eims;com.hepost.eims.until… 不得将类直接定义在基本包下，所有项目中的类、接口等都当定义在各自的项目和模块包中。 类、接口命名规范 所有单词首字母大写。使用能确切反应该类、接口含义、功能等的词。一般采用名词。 接口可带I前缀。 方法命名规范 方法的命名应采用完整的英文描述符，大小写混合使用：所有中间单词的第一个字母大写。法名称的第一个单词常常采用一个有强烈动作色彩的动词。 取值类使用get前缀，设值类使用set前缀，判断类使用is(has)前缀。 例：getName() setSarry() isLogon() 方法参数建议顺序：(被操作者，操作内容，操作标志，其他?) 例：public void replace(String sourceStr, String oldStr, String newStr) { } 常量 采用完整的英文大写单词，在词与词之间用下划线连接，如：DEFAULT_VALUE 变量和参数 采用 直接定义的方法，要做到清晰易懂的原则，如： 实体类 例如：Project project;直接把类型的首个大写字母变成小写字母就行了。 日期型 例如：Date createDate; 组件/部件 应采用完整的英文描述符命名组件（接口部件），遵循匈牙利命名法则