文档介绍：DELPHI
代
码
规
范
文档名称
DELPHI代码规范
描述
该文档描述了在项目开发过程中,开发人员编写代码所应遵循的规范,包括命名规则,代码结构等
负责人
状态
文档变更历史:
时间
修改人
描述
审核人
意见
文档路径:
目录
1 编程风格 4
统一编程风格的意义 4
变量命名规则 4
函数命名规则 4
类命名规则 5
常见语句书写规则 5
注释风格 6
缩进与换行: 6
空格与空行 6
2 代码优化 7
代码优化的意义 7
函数内的代码优化 7
类内的代码优化 7
类之间的代码优化 7
编程风格
统一编程风格的意义
增加开发过程代码的强壮性、可读性、易维护性
减少有经验和无经验开发人员编程所需的脑力工作
为软件的良好维护性打下好的基础
在项目范围内统一代码风格
通过人为以及自动的方式对最终软件应用质量标准
使新的开发人员快速适应项目氛围
支持项目资源的复用:允许开发人员从一个项目区域(或子项目团队)移动到另一个,而不需要重新适应新的子项目团队的氛围
一个优秀而且职业化的开发团队所必需的素质
变量命名规则
一般变量命名规则:前缀字母+名词
1)全局变量:g+名词表示是全局变量如:gUserInfo;系统用户变量
2)局部变量:变量类型简写+名词
i :整数类型;s,str :字符串;c:字符串
iValue; 整数变量
sOldValue或strOldValue; 字符串变量
realNewValue;实数变量
常量命名规则:全部大写,如有多个名词,则用下划线串起来
如:
WM_USER = 12345 消息常量
APPNAME = ‘focustarKBS’字符串常量
类变量命名规则: 前缀表明变量的作用域。
如:
Fxx 表示是类的成员变量
局部变量不允许和全局变量同名
Public或published 不允许定义变量
接口变量命名规则:前缀字母I+名词
函数命名规则
函数名用首字母大写的英文单词组合表示(如用动词+名词的方法),其中至少有一个动词。(骆驼式命名法)
应该避免的命名方式:
和继承来的函数名一样。即使函数的参数不一样,也尽量不要这么做,除非你想要重载它
。
只有一个动词组成,如:Save、Update。改成如:SaveValue、UpdateDataSet则比较好
函数参数的命名规则:
函数参数应该具有自我描述性,应该能够做到见其名而知其意
类命名规则
类名中尽量不要出现下划线。
前缀T开头
接口类命名 Tintf开头
控件命名规则
命名规则:前缀+名词,名词尽量使用有意义的命名
强制程序中有实际使用意义的控件必须要命名。
常用控件列表前缀缩写
类型
缩写前缀
标签类
lbl
单文本编辑类
edt
多文本类
mm
网格类
grid
按钮类
btn
树型类
tree
TClientDataSet
cds
TDataSetProvider
dsp
TDataSource
ds
pack 规范
单元文件命名规则
窗体命名规则:前缀frm