10-Delphi开发规范.doc

文件编码文件密级最新发布日期当前版本Delphi开发规范郑重声明：XX软件股份有限公司版权所有。本文档中任何部分未经XX软件股份有限公司书面授权不得将材料泄露给第三方不得以任何手段、任何形式进行复制与传播。变更履历版本日期变更位置变更理由/变更内容变更人备注1.0新建1.1根据研发项目管理流程问题巡检检查出的问题进行更新：增加变更履历目录1前言32模块划分策略33模块间交互模式设计34编码与命名规范45工程属性和版本命名规范46模块依赖关系47代码构建体系规划57.1源代码目录结构（要考虑第三方类库、公共组件的配置）57.2模块构建输出策略57.3编译/构建选项58附录：构建脚本（ant或FinalBuilder构建文件）68.1附录1FinalBuilder[ForDelphi]工程构建指南68.1.1引入68.1.2设置108.1.3编译118.2附录2VA开发规范介绍128.2.1模块划分128.2.2VA命名规则13前言Delphi开发平台下常规项目一般有两类一类是对单元进行管理的单个exe工程文件一类是通过包(dpk)来组织的大型系统。对于第二类大型系统提供如下工程组织建议。模块划分策略较大规模系统建议划分为基础模块和业务模块两大类。基础模块是系统的基本模块是指系统能够运行的必须依赖的模块。业务模块是系统的扩展模块是指系统可选加载的处理某类业务的模块。业务模块分为基本业务模块和辅助工具模块基本业务模块完成独立业务处理辅助工具模块用来实现模块间的协同处理或扩展系统功能。列出模块列表及功能说明（模块的粒度根据具体情况确定基本原则是公共的、基础的细业务部分粗）在考虑模块划分时要结合版本的划分、分支/合并策略模块间交互模式设计模块间的交互模式按照定义操作规范和发起调用的原则划分可以分为：直接交互、间接交互和辅助交互三种。直接交互：（橙色表示规范定义者箭头背向表示调用发起者红线表示交互或协同工作的双方）直接交互模式是指模块之间有直接的引用或调用关系。直接交互是一种高效、简单的高耦合度交互模式。直接将使模块直接产生依赖关系被引用的模块有任何调整时引用的模块都要做相应的调整并且模块加载时被引用的模块必须加载。直接交互简单高效因此常用于基本模块跟扩展模块直接的交互。间接交互：间接交互模式是指模块之间通过基础模块或公共模块交互的模式协作模块之间没有直接的关系通过公共模块定义的规范交互。间接交互是一种高扩展性的低耦合度交互模式所以是高扩展性系统中扩展模块间的常用交互模式。辅助交互：（虚线表示可能不存在存在与否不影响规范的制定）辅助交互模式是指模块提供遵守某公共规范或自定规范操作接口通过第三方模块调用的交互模式协作模块都被动的等待第三方模块调用。辅助交互一般用于任务可以切割成几块完成而且每小块任务之间相互独立的情况下。辅助交互的模块之间的耦合度为零所以可配置性很强并且可以很好的支持业务过程重组。需要对外提供业务服务的业务模块尽量制定操作规范接口以支持此交互模式。编码与命名规范在遵循公司相关编码和命名规范的基础上在这里补充具体项目的编码和命名规范比如增加前缀、比如结构化命名的分段规范工程属性和版本命名规范DLL/EXE/BPL在编译后有一系列属性值可以通过资源管理器浏览版本命名规范包括内部测试版本和外部正式发布版本（在遵循公司相关规范的基础上）模块依赖关系模块依赖关系表各个模块必须按照编译的顺序列出清晰列出模块之间的依赖关系定义模块的粒度（比如包、单元、类）以及根据具体项目在模块依赖关系表中表现的粒度的策略模块依赖关系是编译时确定模块需要前置编译顺序。通过整理模块依赖关系可以在进行每日构建时保证正确的编译完成。序号模块名称依赖关系模块功能说明备注…11V5SysMngJob。。。12V5BusinessUI。。。13V5SysMngUI11、12…此处维护的是每个模块（包）依赖的包清单。代码构建体系规划源代码目录结构（要考虑第三方类库、公共组件的配置）模块构建输出策略模块输出目标文件规划（DLL/EXE/DCU/BPL、运行包/设计包的考虑Java类似）、输出目录结构、管理策略（根据具体项目情况确定模块的粒度）编译/构建选项根据具体IDE工具确定先列出常用的编译指令或选项及其应用场合附录：构建脚本（ant或FinalBuilder构建文件）附录1FinalBuilder[ForDelphi]工程构建指南对于以包(dpk)组织的大型系统工程打开、编译都是非常耗时的因此利用工具进行系统构建是提高工作效率的有效手段。下面对如何利用FinalBuilder进行Delphi系统构建进行介绍说明。引入首先是新建一个FinalBuilder工程引入需要进行编译的工程文件。步骤如下图所示步骤一点击进入ImportDelphi