delphi程序规范说明书

《delphi程序规范说明书》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、Delphi程序规范说明书目录一、开发环境2二、软件编码规范2（一）编码原则2（二）对象命名约定21类定义前缀22窗体和模块定义后缀33组件定义前缀34一般变量及形式参数命名35方法／函数命名46关键字／一般变量类型命名47单元／文件命名4（三）结构化编码约定4（四）注释的约定51文件头52重要变量注释53分块注释54注释语言5（五）数据库访问约定51OLEDB/ADO52数据模块63SQL编程6三、软件界面规范6（一）基本约定6（二）提示信息样式68一、开发环境l开发系统平台：Windows98,Windows2000Professional/Se

2、rver,WindowsXPl开发工具：前台采用Delphi6.0作前端开发工具，后台以SQLServer2000作数据库服务器。l屏幕分辨率：800*600,16位色以上，普通字体。l网络平台：10/100M以太网l计算机及外设：标配计算机，打印机二、软件编码规范（一）编码原则l每人各自在自己的模块文件名前加上前缀模块前缀例查询模块QryQryQueryFrm.pas,QryInputDlg.pasQryDataMdl.pas导入导出IO公用模块Pub录入模块Mnt用户管理Usr统计分析模块Stc报表模块Rpt主模块无MainFrm.pasl采用面

3、向对象的方法设计。除非绝对有必要，不要出现全局函数／方法和全局变量。l所有MDI子窗口从TChildForm继承l采用单元(Unit)、包(Package)以及组件(Component)的形式作为软件的模块组成形式，除非有必要，一般不开发DLL。l每人各自维护自己的子项目(Project)，但要留出公共调用接口，一般为一个全局函数／方法，以便最后组成总项目时调用。如：在MDI子窗口的Unit的interface部分，写上ShowMDIChildForm(AOwner:TComponnet;…)方法。例：procedureShowMDIChildFor

4、m(AOwner:TComponent;…);beginifAssigned(ChildForm)then8beginChildForm.Show;Exit;end;ChildForm:=TChildForm.Create(AOwner);ChildForm.Show;end;…procedureTChildForm.FormClose(Sender:TObject;varAction:TCloseAction);begininherited;ChildForm:=nil;end;（一）对象命名约定公式：对象名称=对象前缀+自定义名称或　对象名称=自

5、定义名称+对象后缀注：1.自定义名称要有一定的意义且第一个字母大写3.如果是不需要对其编码的对象，那么对象名用默认对象名。如：Label1按照Delphi推荐使用的对象命名约定，做出以下规定：1类定义前缀以T-作为类定义前缀。如：TClass1。2窗体和模块定义后缀以-Form,-Dialog,-Module做后缀。类型后缀类定义变量实例窗体-FormTMainForm,MainForm对话框-DialogTAboutDialogAboutDialog数据模块-ModuleTDataModuleDataModule公共模块-ModuleTPublic

6、ModulePublicModule81组件定义前缀以组件名缩写做前缀。前缀字母全小写。下面的规则说明如何定义一个组件类型前1)从组件类型名中移去T前缀。例如TButton变成button。2)除了第一个元音，删去所有元音字母。例如，button变成bttn，edit变成edt。3)压缩双字母。例如，bttn变成btn。4)如发生冲突，则在某一组件前缀中加入一个元音。例如在TBatton组件的前缀中加入元音变为batn，以区别TButton的前缀。5)如转换后前缀仍然太长，可适当去掉一些辅音字母，尤其是多个单词组成的组件名。如:StringGrid。

7、类型前缀类定义变量实例MainMenumnmnuTMainMenumnmnuMainMenuItemmnuitmTMenuItemmnuitmExitButtonbtn-TButtonbtnCloseLabellbl-TLabellblPromptStringGridstrgrd-(去掉了ng)TStringGridstrgrddxDBGriddbgrdTdxDBGriddbgrdPriceADOConnectionadocnnTADOConnectionadocnnMainADOCommandadocmdTADOCommandadocmdInser

8、tADODataSetadodstTADODataSetadodstTableADOTableadotblT