文档介绍：软件开发标准技术文档
(Delphi)
编
码
规
范
SeanOuyang软件技术文档
2012年
修改记录
序号
版本号
拟制人/修改人
拟制/修改日期
更改备注
1
seanouyang
2012-07-10
初稿(来源于网络)
2
seanouyang
2012-07-14
修改
目录
一、前言 5
二、基本规范 6
缩进 6
空格 6
边距 6
保留字和关键字 6
声明和赋值 6
运算符号 6
注释 7
括号 7
begin...end 语句 8
库单元分类 8
三、常用规范 9
过程和函数 9
变量 9
类型 10
语句 11
结构异常处理 12
类类型 13
域 14
属性 14
四、文件 15
15
Unit文件 15
窗体单元 16
构件单元 16
文件头 16
五、窗体和数据模板 17
窗体 17
数据模板 18
六、包 19
使用运行包和设计包的比较 19
文件命名标准 19
七、构件 20
用户自定义构件 20
构件单元 20
使用注册单元 20
构件实例命名约定 20
构件的前缀 20
Standard页 20
Additional页 21
Win32页 21
System页 22
页 22
Data Access页 23
Data Controls页 23
Decision Cube页 24
QReport页 24
Dialogs页 25
25
Samples页 25
ActiveX页 26
Midas页 26
八、注释规范 27
27
27
27
27
一、前言
软件的长期价值直接源于其编码质量。在它的整个生命周期里,一个程序可能会被许多人阅读或修改。如果一个程序可以清晰的展现出它的结构和特征,那就能减少在以后对其进行修改时出错的可能性。
本文档详述了在Delphi下进行编程的代码编写标准。在通常情况下,本文档遵循“取消”式格式的指引方针,该方针由Borland国际通过一些例外来使用。在Delphi 开发者指南中包含本文档的目的在于阐述一种方法,通过该方法,开发小组可以在他们所编写的代码中保持一贯的风格。这样做的目的是使在开发小组中的每一个程序员都可以明白其他程序员的代码。这有助于提高代码编写的可读性和使用的一贯性。
二、基本规范
缩进
缩进就是每级间有两个空格。不要在源代码中放置制表符(TAB)。这是因为,制表符的宽度随着不同的设置和代码管理实用程序(打印、文档及版本控制等)而不同。
通过使用Tools|Environment 菜单,在Environment Options 对话框的General页上,不要选中Use Tab Character 和Optional Fill 复选框,这样,制表符就不会被保存。
空格
遇到如下情况,需要添加空格:
1) 逗号的后面;
2) 冒号(不包括赋值语句中的冒号)的后面;
3) 等号的前后;
4) 赋值号的前后
5) 运算符(+、-、*、/)的前后。
边距
边距一般设置为80个字符,如遇到特殊情况可以增加到90个字符(建议使用1024*768以上的分辨率查看)。本规则比较灵活。长度超过一行的语句应当用逗号或运算符换行。换行后,应缩进两个字符。
保留字和关键字
Object Pascal 保留字和关键字永远是全部小写。
声明和赋值
声明形参时形参靠近冒号,类型与冒号空出一个格。
例:aStr: string;
多个同一类型的形参应当归并一起声明时,用逗号分开,后一个形参与逗号空一个格。
例:aStr, aName, aPwd: string;
付值时变量与数值均与付值符号间隔一个格。
例:aStr := ‘hello’;
运算符号
运算符号与左右两个参量间空出一个格,如有两层以上的运算关系必须使用“()”来分隔开.
例:if aInt > 100 then
aInt := (aInt * 5) d