编码开发规范.doc

海丰集运 编码开发规范 上海吉联新软件有限公司 GL-07P-005 海丰集运综合业务管理信息系统 软件开发中心 Gillion Restricted Page PAGE 1 of NUMPAGES 17 Template Version: 1.3 Last changed: SAVEDATE \@ dd MMMM yyyy 10 January 2014 at SAVEDATE \@ HH:mm 10:53 编码规范说明书 中海集运滞期费管理信息系统 中海集运 文档编号： 生效日期： 密级： 版本：R1.0 编制： 审核： Copyright Notice Copyright? 2003 - 2009 Gillion Technologies Ltd. No part of this publication may be copied without the express written Permission of Gillion Technologies Ltd. 修订历史 Date Revision Description Author 2014-01-04 R1.0 Create 林华  TOC \o 1-3 \h \z \u 导言 5 1.1. 编写目的 5 1.2. 内容边界 5 1.3. 术语及缩写 5 1.4. 文档结构 5 1.5. 参考文档 5 1. 声明 5 总体描述 5 1.1. 包 5 1.2. 类、接口 6 1.3. 方法 6 1.4. 字段 6 1.5. 代码示例 7 2. 命名 7 总体描述 7 2.1. 包与类命名 8 2.1.1. 包命名 8 2.1.2. 类命名 8 2.1.3. Entity对象命名 8 2.1.4. Service命名 8 2.1.5. DAO命名 9 2.1.6. Exception命名 9 2.2. 属性命名 9 2.2.1. 成员变量和参数命名 9 2.2.2. 常量命名 10 2.2.3. 项目中控件/组件命名 10 2.3. 方法命名 11 2.3.1. Entity类中方法命名 11 2.3.2. Service类中方法命名 11 2.3.3. 项目中的方法命名 12 3. 注释 12 总体描述 12 3.1. 类、接口注释 12 3.2. 方法注释 13 3.3. 其它注释 13 3.4. 常用JavaDoc标记 13 4. 代码组织与风格 14 总体描述 14 4.1. 缩进 14 4.2. 长度 14 4.3. 行宽 14 4.4. 间隔 15 4.5. 括号 15 5. 性能与安全 15 总体描述 15 5.1. 通用性能优化 15 5.1.1. String与StringBugffer 15 5.1.2. 集合 15 5.1.3. 对象 16 5.1.4. final 16 5.1.5. abstract 16 5.1.6. 垃圾收集和资源释放 16 5.1.7. 慎用异常 16 导言 编写目的 本规范的目的是为了使海丰集运项目开发小组能以标准的、规范的方式进行编码。通过该规范的学习，以使开发人员养成良好的编码风格和习惯，并以此形成开发小组编码约定，提高程序的可靠性、可读性、可维护性和一致性等，增进团队间的交流，并保证软件产品的质量。 内容边界 结合项目实际开发情况和Java基础语法知识,主要针对声明、命名、注释、代码组织与风格、性能和安全等方面进行规范和说明。 术语及缩写 全称 含义 文档结构 参考文档 资料名称 位置 声明 总体描述 声明的基本原则是遵守Java语言规范，并遵从项目习惯用法。 包 在导入包时当完全限制代码所有的类的名字，尽量少用通配符的方式，但导入一些通用包，或用到一个包下大部分类时，则可使用通配符方式,如： 例如: import mons.beanutils.PropertyUtils; import java.util.*; 同意个包中的类的导入时当声明在一起，可由编辑器自动完成功能。 Eclipse采用ctrl+shift+O 导入包 类、接口 类、接口定义语法规范：[可见性][(abstract|final)] [Class|Interface] class_name [(extends|implements)][父类或接口名]{ } 例如： pub