delphi 编码规
范文档
目录
1、前言 ............................................................................................................................................................... 2 2、源程序书写规范 ........................................................................................................................................... 2 2.1 通用源代码格式规范 ........................................................................................................................... 2 2.2 Object Pascal 语句格式书写规范与用法 ............................................................................................. 3 3 命名规范 .......................................................................................................................................................... 7 3.1 过程(Procedure)与函数(Function) ........................................................................................................ 7 3.2 变量(Variable) .................................................................................................................................. 8 3.3 类型(Type)........................................................................................................................................ 9 3.4 面向对象相关 ..................................................................................................................................... 15 3.5 文件 ..................................................................................................................................................... 16
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 例如: if som
e statement = then begin ... end else begin Some Other Statement; end;
2.1.4 注释
我们通常使用“{...}”类型的块注释,以前的“(*...*)”类型的块注释用于临时注释掉暂不使用的代码, 单行注释可以使用“//”注释。 一般来说 Function 和 Procedure 前必须有注释。注释的格式如下: ////////////////////////////////////////////////////////////////////////////// // 时间:2009-06-25 by Auther // 说明: | // 参数: // 返回: /////////////////////////////////////////////////////////////////