delphi编码规
范文档 作者:arsoon
目录
1、前言 3
2、源程序书写规范 3
2.1通用源代码格式规范 3
2.1.1缩进 3
2.1.2边距 3
2.1.3 Begin…End语句 3
2.1.4注释 4
2.2 OBJECT PASCAL语句格式书写规范与用法 4
2.2.1括号 4
2.2.2保留字和关键字 4
2.2.3过程和函数 5
2.2.4变量 5
2.2.5类型 6
2.2.6语句 6
2.2.7结构化异常处理 7
3命名规范 8
3.1过程(PROCEDURE)与函数(FUNCTION) 8
3.1.1命名 8
3.1.2形参 9
3.1.3命名冲突 9
3.2变量(VARIABLE) 9
3.2.1局部变量 9
3.2.2全局变量 9
3.3类型(TYPE) 9
3.3.1一般类型 9
3.3.2构造类型 10
3.3.3类类型(Class) 10
3.3.4元件类型 11
3.3.5窗体和对话框类型 13
3.3.6数据模块类型 15
3.4文件 16
3.4.1项目文件 16
3.4.2窗体文件 16
3.4.3数据模块文件 16
3.4.4远程数据模块文件 16
3.4.5单元文件 17
4、DELPHI代码自动格式化工具 18
1、前言
本
文档主要是为Delphi开发人员提供一个源代码书写标准,以及程序和文件的命名标准,使他们在编程时有一致格式可遵循。这样,每个编程人员编写的代码能够被其他人理解。
注:本
文档不包含用户界面标准。用户界面标准是独立于其他标准的,并且同样是重要的。
2、源程序书写规范
2.1通用源代码格式规范
2.1.1缩进
缩进就是每级间有两个空格。不要在
源代码中放置制表符。这是因为,制表符的宽度随着不同的设置和代码管理实用
程序(打印、文档及版本控制等)而不同。
通过使用Tools|Environment 菜单,在Environment Options 对话框的General页上,不要选中Use Tab Character 和Optional Fill 复选框,这样,制表符就不会被保存。
2.1.2边距
边距设置为80个字符。源代码一般不会因写一个单词而超过边距,但本规则比较灵活。只要可能,长度超过一行的语句应当用逗号或运算符换行。换行后,应缩进两个字符。
2.1.3 Begin…End语句
begin 语句必须单独占一行。例如,下面第一行是错误的,而第二行正确:
for i:=0 to 10 do begin // 错, begin 与f o r 在同一行
for i:=0 to 10 do // 对, begin 在另外一行中
begin
本规则的一个特殊情况是,当begin 为else 语句的一部分时,例如:
if some statement = then
begin
. . .
end
else begin
Some Other Statement;
end;
注意:end 语句总单独一行。当begin 不为else 语句的一部分时,相应的end 语句与begin 语句的缩进量相同。
2.1.4注释
我们通常使用“{...}”类型的块注释,以前的“(*...*)”类型的块注释用于临时注释掉暂不使用的代码,从Delphi 2开始支持“//”行注释,如果决定不在支持
Delphi 2.0以下的版本,可以使用“//”注释。
2.2 Object Pascal语句格式书写规范与用法
2.2.1
括号
在左括号与下一字符之间没有空格。同样,右括号与前一字符也没有空格。下面的例子演示了正确与不正确的空格。
CallProc( Aparameter ); // 错!
CallProc(Aparameter); // 正确!
不要在语句中包含多余的括号。在源代码中,括号只有在确实需要时才使用。下面的例子
演示了正确与不正确用法:
if (I=42) then // 错,括号是多余的
if (I=42) or (J=42) then // 正确,必须使用括号
2.2.2保留字和关键字
Object Pascal 语言的保留字和关键字总是完全的小写。下面是Delphi 5保留字
列表:
and array as asm
begin case class const
constructor destructor dispinterface div
do downto else end
except exports file finalization
finally for function goto
if implementation in inherited
initialization inline interface is
label library mod nil
not object of or
out packed procedure program
property raise record repeat
resourcestring set shl shr
string then threadvar to
try type unit until
uses var while with
xor private protected public
published automated
2.2.3过程和函数
□ 格式
过程名应当以大写字母开始,且大小写交错以增加可读性。下面是一个不