2022年Delphi软件开发编码规范 .pdf

《2022年Delphi软件开发编码规范 .pdf》由会员分享，可在线阅读，更多相关《2022年Delphi软件开发编码规范 .pdf（5页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、FZXT/RK10-S07Delphi软件开发编码规范版次： 1.0第 1 页 共 5 页Delphi 软件开发编码规范1、 目的为了统一公司软件开发设计过程中关于数据库CLIENT端开发对象设计的规范，便于交流和维护，特指定福州迅腾网络科技有限公司软件开发人员，研究和编制本编码规范。2、 适用范围公司软件开发部开发过程3、命名规范Delphi 被人们称为“第四代编程语言”，它具有基于窗口和面象对象的方法、高速的编译、强大的数据库支持与Windows 的紧密结合。 基于以上特点， 同时考虑到提高软件开发效率，降低软件开发过程中出现错误的可能性、增强程序可读性，并使软件系统各模块保持一致的风格，

2、特制定本规范。一般规范：1） ObjectPascal 语言的保留字和关键字总是全部小写。2） Win32 API 类型总是全部大写。3）begin,end语句总是单独占一行，但是当begin 为 else 语句的一部分时， begin同 end一起占一行，如：ifsome statementthenbeginEndelsebeginend;3.1窗口窗口的命名必须以frm（Form 缩写）开头，加 _+开发子模块简码 ( 如财务CW)+ 该窗口对应菜单的英文单词或是英文单词缩写。如果没有对应的菜单，那就以frm_加_+模块+窗口功能英文单词或是英文单词缩写s 。例如：序号窗口名称说明1Frm

3、_main系统主界面2Frm_xt_userset系统模块的用户设置窗口3Frm_xt_userinfo系统模块的用户信息窗口3.2单元单元文件以U+ 该单位的窗口名称。如果没有对应的窗口，以U+ 单位的具体功能的英文单词或是英文单词缩写序号单元名称说明1UPublicVal公用变量统一定义单元2UPublicFunction公用函数统一定义单元3Ufrm_main主单元4Ufrm_xt_userset用户设置窗口单元3.3类和大多数 Pascal 程序一样， Delphi应用程序强调单元或程序模块的使用。实际上，在引入类之前， 单元是模块化编程的基础，而类是建立在单元的概念基础上的。因此类的

4、命名名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 1 页，共 5 页 - - - - - - - - - FZXT/RK10-S07Delphi软件开发编码规范版次： 1.0第 2 页 共 5 页在一般情况下第一个字母为大写的T 其后再加上单元的命名即可。3.4菜单主菜单 （TMainMenu ） 的命名必须以mm开头， 弹出菜单以pm开头加_+加具体功能英文单词或是英文单词缩写菜单项（ TMenuItem ）的命名以delphi默认的生成的即可.序号菜单名称Comments1Mm

5、_main主菜单2PM_edit弹出菜单编辑3.5函数函数的命名必须以fuc （Function缩写）开头，其后紧接与意义相关联的名称词干。名称词干为一到多个 （不要太多， 总长不得超过Delphi的限制且不得使用Delphi系统禁用的字母） 英文单词或英文单词缩写或拼音简写，各英文字母的第一个字母大写。名称词干要考虑到描述对象单数复数，对复数应该在词干后面加上小写s 。例如：序号函数名称Comments1fucFileLong取文件长度函数2fucAddData增加数据函数3fucCount统计函数3.6过程过程的命名必须以pro（Procedure缩写）开头，其后紧接与意义相关联的名称词干

6、。名称词干为一到多个（不要太多， 总长不得超过Delphi的限制且不得使用Delphi系统禁用的字母） 英文单词或英文单词缩写或拼音简写，各英文字母的第一个字母大写。名称词干要考虑到描述对象单数复数，对复数应该在词干后面加上小写s 。另外关于过程中形参的顺序（函数也相似） ，最常用的参数应当作为第一个参数，按使用频率依次从左到右排；输入参数位于输出参数之前；范围大的参数应当放在范围小的参数之前。例如：序号过程名称Comments1proDeleteFile删除文件过程2proOpenDat打开数据文件过程3proCleanScreen清屏过程3.7控件三方控件都有192.168.1.179so

7、ft集装箱项目文挡 第三方控件目录下面都必须安装 delphi代码自动排序插件ctrl+D代码自动排序。控件的命名必须以控件类型的英文缩写开头，加_, 其后紧接与意义相关联的名称词干。名称词干为一到多个（不要太多， 总长不得超过Delphi的限制且不得使用Delphi 系统禁用的字母）英文单词或英文单词缩写或拼音简写，各英文字母的第一个字母大写。例如：序号控件名称Comments1Bt_Ok“OK ”按钮 (Tbutton控件)2Mg_ItemSample组示例图像（ Timage 控件）3Tv_AllFile显示所有文件（ TTreeView控件）常用控制的开头规范:数据源控件主要以 ODA

8、C 这个第三方控件用到 Session 控件开头以 OS_orqquery控件OQ_smartquerySQ_orasql()OC_名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 2 页，共 5 页 - - - - - - - - - FZXT/RK10-S07Delphi软件开发编码规范版次： 1.0第 3 页 共 5 页oratableOT_OraStoredProc1OP_OraDataSource1DS_VirtualTable1VT_数据感知控件主要以昆腾IP 两种控件gr

9、idGD_dbeditDBE_DBComboBoxDBC_DBLookupCombo DBLDBDateTimePickerdbdt_报表控件，以fastreport控件,frReportFR_frDBDataSetfrDS_( 直接加上对应的frport的后缀)界面的还有常用的控件 ( 如button,label)统一用 RaizexpmenubuttonBT_toolbarTB_listviewLV_treeviewTV_图形控件用tcad,和OxPlan3.8变量变量的命名必须以变量作用范围前缀（g、u、l分别代表变量作用范围为全局、单元、本过程） +变量类型的英文缩写开头( 一般字符串

10、类型用s，整型用 i) ，加_+其后紧接与意义相关联的名称词干。名称词干为一到多个（不要太多，总长不得超过Delphi的限制且不得使用 Delphi系统禁用的字母）英文单词或英文单词缩写或拼音简写，各英文字母的第一个字母大写。名称词干要考虑到描述对象单数复数，对复数应该在词干后面加上小写s 。例如：序号变量名称Comments1Gs_FileName“文件名”字符串类型（全局）2Ui_FileCount“文件总数”整型（单元）3Lr_Height“高度”实型（本过程）3.9常量在 Delphi中常量的定义有两种方式Const 方式和 Resourcestring方式，前者是常量命名的一般方式，

11、 后者定义的字符串常量被存储在程序的资源中的一个字符串表格中。不论用哪种方式定义常量，常量的命名必须以常量作用范围前缀（g、u、l分别代表常量作用范围为全局、单元、本过程）+cst （Const的英文缩写）开头， +_+其后紧接与意义相关联的名称词干。名称词干为一到多个（不要太多，总长不得超过Delphi的限制且不得使用Delphi系统禁用的字母）英文单词或英文单词缩写或拼音简写，各英文字母的第一个字母大写。名称词干要考虑到描述对象单数复数，对复数应该在词干后面加上小写s 。例如：序号常量名称Comments1Ucst_CircelNumber循环次数（单元）2Gcst_ServerName服

12、务器名（全局）4、编码规范4.1过程及函数的编码规范4.1.1注释名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 3 页，共 5 页 - - - - - - - - - FZXT/RK10-S07Delphi软件开发编码规范版次： 1.0第 4 页 共 5 页1） 请在一开始处严格按如下格式写出注释：/过程（或函数）名：/功能描述：/参数说明：/返回值：/时间：/修改者：/修改时间：2） 请在重要的程序段和难懂的程序段加上注释，程序中的注释量不能少于代码量的10% 。3） 所有运算符

13、（包括:= 号）与相关变量之间留一个空格。4.1.2变量取名及含义变量取名请遵守命名规范，对使用频繁、关键变量，为了便于阅读和修改，请在定义时加上注释标明其含义。4.1.3书写格式1） 用分层缩进的写法显示嵌套结构的层次；2） 在注释段与程序段、以及不同程序段插入空行；3） 每行只写一条语句。4.2类及单元编码规范4.2.1注释在类及单元的开始之前写出其功能, 具体格式为:/功能说明：/参数说明：/程序员姓名：/时间：/修改者：/修改时间：/脚本开始处4.2.2变量取名及含义变量取名请遵守命名规范，对使用频繁、关键变量，为了便于阅读和修改，请在定义时加上注释标明其含义。4.3程序基本构成为使程

14、序清楚易读便于管理，特对一些程序中的特殊元素作如下规定。4.3.1公用元素公用元素指“公用变量” 、 “公用过程” 、 “公用函数”等，由于公用元素对程序中所有单元、过程都是可见的，故对它们的修改将会对整个程序造成影响。“公用变量”过多也会破坏数据的隐藏性，与“面向对象编程”的规范不符。所以对公用元素的编程要求如下。1） 所有“公用变量”都必须在PublicVal单元（自建）中定义，以便查询修改。2） 所有“公用过程”都必须在PublicPro单元（自建）中建立，并附上详细注释。3） 所有“公用函数”都必须在PublicFuc单元（自建）中建立，并附上详细注释。如果不遵守上述规定可换来很大的性

15、能提高可不遵守上述规定，但请慎重考虑。4.3.2函数返回值使用 Result代替函数名来赋予一个函数返回值可使程序更易读。4.3.3注释名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 4 页，共 5 页 - - - - - - - - - FZXT/RK10-S07Delphi软件开发编码规范版次： 1.0第 5 页 共 5 页“/.”注释用于对程序的注解等。“.”注释用于对程序修改时临时删除部分程序代码。5、 其他为了保证整个系统的界面风格一致性, 请注意：各种标题、文本使用的字体、大小和颜色的设置。一般情况设置如下：字体：宋体；字体样式：规则；大小： 11；颜色：黑色；语系： CHINESE_GB2312;无下画线和删除线。各种按钮的大小、位置、排列。按钮的位置和排列视实际情况而定，标准是美观大方；具有确定或取消功能及相似功能的按钮大小设置如下：Height:25;Width:65。名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 5 页，共 5 页 - - - - - - - - -