1、Delphi 程序规范说明书目录一、 开发环境 .2二、 软件编码规范 .2（一） 编 码原则 .2（二） 对象命名约定 .21 类定义前缀 22 窗体和模块定义后缀 33 组件定义前缀 34 一般变量及形式参数命名 .35 方法函数命名 46 关键字一般变量类型命名 47 单元文件命名 4（三） 结构化编码约定 .4（四） 注释的约定 .51 文件头 52 重要变量注释 53 分块注释 54 注释语言 5（五） 数据库访问约定 .51 OLEDB/ADO 52 数据模块 63 SQL 编程 .6三、 软件界面规范 .6（一） 基本约定 .6（二） 提示信息样式 .62一、开发环境 开发系统平
2、台：Windows 98, Windows 2000 Professional/Server, Windows XP 开发工具：前台采用 Delphi 6.0 作前端开发工具，后台以 SQL Server 2000 作数据库服务器。 屏幕分辨率：800*600, 16 位色以上，普通字体。 网络平台：10/100M 以太网 计算机及外设：标配计算机，打印机二、软件编码规范（一）编码原则 每人各自在自己的模块文件名前加上前缀模块 前缀 例查询模块 Qry QryQueryFrm.pas, QryInputDlg.pasQryDataMdl.pas导入导出 IO公用模块 Pub录入模块 Mnt用户
3、管理 Usr统计分析模块 Stc报表模块 Rpt主模块 无 MainFrm.pas 采用面向对象的方法设计。除非绝对有必要，不要出现全局函数方法和全局变量。 所有 MDI 子窗口从 TChildForm 继承 采用单元(Unit) 、包(Package)以及组件(Component)的形式作为软件的模块组成形式，除非有必要，一般不开发 DLL。 每人各自维护自己的子项目(Project)，但要留出公共调用接口，一般为一个全局函数方法，以便最后组成总项目时调用。如：在 MDI 子窗口的 Unit的 interface 部分，写上 ShowMDIChildForm(AOwner: TComponn
4、et; )方法。例：procedure ShowMDIChildForm(AOwner: TComponent; );begin3if Assigned(ChildForm) thenbeginChildForm.Show;Exit;end;ChildForm := TChildForm.Create(AOwner);ChildForm.Show;end;procedure TChildForm.FormClose(Sender: TObject; var Action: TCloseAction);begininherited;ChildForm := nil;end;（二）对象命名约定公式
5、： 对象名称 = 对象前缀 + 自定义名称或 对象名称 = 自定义名称 + 对象后缀注：1. 自定义名称要有一定的意义且第一个字母大写3. 如果是不需要对其编码的对象，那么对象名用默认对象名。如：Label1按照 Delphi 推荐使用的对象命名约定，做出以下规定：1 类定义前缀以 T- 作为类定义前缀。如：TClass1。2 窗体和模块定义后缀以 -Form, -Dialog, -Module 做后缀。类型 后缀 类定义 变量实例窗体 -Form TMainForm, MainForm对话框 -Dialog TAboutDialog AboutDialog数据模块 -Module TData
6、Module DataModule4公共模块 -Module TPublicModule PublicModule3 组件定义前缀以组件名缩写做前缀。前缀字母全小写。下面的规则说明如何定义一个组件类型前1) 从组件类型名中移去 T 前缀。例如 TButton 变成 button 。2) 除了第一个元音，删去所有元音字母。例如，button 变成 bttn ，edit 变成 edt 。3) 压缩双字母。例如，bttn 变成 btn 。4) 如发生冲突，则在某一组件前缀中加入一个元音。例如在 TBatton 组件的前缀中加入元音变为 batn ，以区别 TButton 的前缀。5) 如转换后前缀仍
7、然太长，可适当去掉一些辅音字母，尤其是多个单词组成的组件名。如: StringGrid。类型 前缀 类定义 变量实例MainMenu mnmnu TMainMenu mnmnuMainMenuItem mnuitm TMenuItem mnuitmExitButton btn- TButton btnCloseLabel lbl- TLabel lblPromptStringGrid strgrd- (去掉了 ng) TStringGrid strgrddxDBGrid dbgrd TdxDBGrid dbgrdPriceADOConnection adocnn TADOConnection
8、adocnnMainADOCommand adocmd TADOCommand adocmdInsertADODataSet adodst TADODataSet adodstTableADOTable adotbl TADOTable adotblTableADOQuery adoqry TADOQuery adoqryQueryADOStoredProc adosp TADOStoredProc adospProcedure4 一般变量及形式参数命名 与 VB, VC 不同，所有一般变量不加类型前缀。 类成员变量加 F- 前缀。如：FMember 形式参数加 A- 前缀。如：procedu
9、re Proc1(APram1: Integer)5 方法函数命名以实际意义命名，每个单词第一个字母大写。如：procedure WriteText()56 关键字一般变量类型命名关键字所有字母小写，一般变量类型的第一个字母大写。命名 类型begin 关键字unit 关键字string (注：string 为关键字) 关键字Single 一般变量类型Integer 一般变量类型Char 一般变量类型AnsiString 一般变量类型7 单元文件命名按照该单元的核心类定义名称，并适当缩写。公式：文件名模块前缀+自定义名称+ 缩写后缀缩写规则：模块前缀，如：Qry-, IO-, 缩写后缀，如：-F
10、orm，缩写为 Frm类型 类定义 后缀 单元 文件名窗体 TMainForm -Frm MainFrm MainFrm.pas, MainFrm.dfmQryQueryFrm.pas对话框 TAboutDialog -Dlg AboutDlg AboutDlg.pas, AboutDlg.dfmIOInputDlg.pas数据模块 TDataModule -Mdl DataMdl DataMdl.pas, DataMdl.dfmRptDataMdl.pas公共模块 TPublicModule -Mdl PublicMdl PublicMdl.pas, PublicMdl.dfmPubPubl
11、icMdl.pas（三）结构化编码约定 采用具有缩进结构的格式化代码。注：缩进字符数规定为 2 个空格。 如果一个函数方法长度过长，一般超过 100 行，将其内部分为若干个子函数方法。 结构化异常处理 动态分配变量的释放6（四）注释的约定1 文件头所有源文件和项目文件都应具有文件头。一个正确的文件头应包含以下信息：Copyright YEAR by AUTHORSDescription: 2 重要变量注释每一个重要变量的声明应该包括表明其用途的注释。3 分块注释在每个函数方法体内部，在相对独立的每个逻辑子块前加上注释。如：procedure Proc1(AParam1: Integer)beg
12、in/ initialize procedure 初始化/ do a loop 循环/ exit 退出end;4 注释语言英文/中文（五）数据库访问约定1 OLEDB/ADO访问数据库使用 OLEDB/ADO，但如果在有的技术 ADO 解决不了的情况下可用其他方法。72 数据模块 在数据模块中定义主 Connection：adocnnMain，程序中所有访问数据库的代码均使用此 Connection，不能使用自己的 Connection。 各自在自己的单元内定义相应的 ADOQuery、ADOCommand、ADOStoredProc，但其 connection 应指向 adocnnMain。
13、 在数据模块中定义全局的变量。如：User, Password 等,但应采用property 的形式。3 SQL 编程尽量不在 Delphi 中编写 SQL 语句，凡是固定的 SQL 语句都以存储过程、视图的形式在 SQL Server 中编写，在 Delphi 中通过传递参数调用。三、软件界面规范（一）基本约定 MDI 窗口风格 在菜单、按钮中加入热健(Hotkey)、快捷健(Shortcut) 如果菜单命令需弹出对话框，则在菜单项的文字末尾加省略号 在窗体中定义组件的 Tab 顺序。 使用 TActionList 组合菜单及工具条的操作 字体采用宋体 9 号 色彩使用系统默认色（二）提示信
14、息样式（1）当操作出现严重错误时，提示如下的消息框（根据具体情况修改提示语句）MessageBox (Handle, , PChar(错误) , MB_ICONERROR or MB_?)（2）当操作出现一般错误时，提示如下的消息框（根据具体情况修改提示语句）MessageBox (Handle, , PChar(警告) , MB_ICONWARNING or MB_?)（3）当需要提示用户、给出结果时，提示如下的消息框（根据具体情况修改提示语句）8MessageBox (Handle, , PChar(信息) , MB_ICONINFORMATION or MB_?)（4）当需征求操作者意愿时，提示如下的消息框（根据具体情况修改提示语句）MessageBox (Handle, , PChar(询问) , MB_ICONQUESTION or MB_?)
