精华公布栏

发信人: freely (www.BeatIt.cc), 信区: BorlandDev
标  题: [SoftEng]Delphi开发者代码标准文档(转载)
发信站: 哈工大紫丁香 (2001年08月11日09:57:01 星期六), 站内信件

【以下文字转载自 Programming 讨论区】
【原文由 xxxxx 所发表】

这篇文章我是接着我师父翻译的，我估计他翻译过了，但是我没有完整稿所以就
接着来的。后来看到好象有人也翻译并发表了。所以，我就把我师父跟我翻译的部分
（节）贴出来吧。
                  Delphi 4 开发者代码标准文档指南
             作者:XavierPacheco and Steve Teixeira 1998
                  翻译:刘洋（WhiteCrow） 1999/9/3-
                       张名举2000/12/5
绪论
这篇文档是为了使用Delphi像在《Delphi 4 Developer's Guide》中那样开发的代码标

准。一般来说，本文是Borland国际公司几乎没有例外地经常使用的未成文的格式化标准

。打算在《Delphi 4 Developer's Guide》中包含该文档以向一些开发组织在编码阶段

可以执行一个一致的风格，可以让每一个组织中的程序员能读懂其他程序员所写的代码

。一致性的使用能提高代码的易读性。
这篇文档不想包含任何显而易见应当存在于代码标准中的规定。但是，它包含的内容足

够使你进行设计。你可以按着你的需要轻松地使用和修改这些标准。我们不推荐您使用

的标准偏离被Borland公司作为开发支柱的标准很远。我们不赞同这些是因为像您将成为

您队伍中一个新的程序员，而他们大多数可能已经是习惯使用Borland公司的标准了。像

大多数代码标准文档，这篇文档也需要不断的发展和完善。因此你要经常在www.xapwar

e.com/ddg在线更新版本。这篇文档不替代《User interface standards》。这是一些彼

此独立但又同等重要的话题。由第三方书籍和微软文件能替代的指导方针我们坚决不重

复这些信息，但是在涉及到Microsoft Developers Network和其他来源时有些信息可能

会提到。
普通源码格式化规则
缩进格式
每一层都要缩进两个空格。不要把TAB字符存到源码文件中。理由是因为tab字符因不同

的用户和不同的源码管理器的设置而扩展的空格宽度不同（例如：打印，存档，版本控

制等等）。
你可以通过关闭在Environment Options对话框（选择Tools|Environment）上的Editor

页中"Use tab character"和"Optimal fill"选择框禁止存储tab字符。
页的边界
页边界将被设置成80个字符。通常情况下，源码不要超过这个边界宽度，但是这一规定

有一定的灵活性。无论怎样都会存在语句在逗号或操作符之后超过一行的，当发生这种

情况时，它将在原始声明行的基础上缩进两个字符的位置。
成对的Begin..End
begin语句应该出现在单独一行。例如，下面第一行是错误的；第二行是正确的：
for I := 0 to 10 do begin //错误，begin和for在一行
for I := 0 to 10 do             //正确，begin出现在单独的一行
begin
这个规则当begin语句出现在一个else子句部分时是个例外：
        if 一些语句 = then
        begin
                …
end
else begin
                另一些语句;
end;
end语句永远出现在单独的一行。
当begin语句不是出现在else子句部分时，相应的end语句总是于它的begin部分成锯齿状

匹配。
面向对象的Pascal
括号
在左括号和下一个括号之间永远也没有空格。同样，在右括号和前一个字符之间也永远

没有空格。下面举个分别错误和正确的例子让您注意括号的用法：
CallProc( Aparameter ); //错误
CallProc(Aparameter);  //正确
在一个语句中不要包含无意义的括号。括号只应该出现在必须使用它才能完成逻辑的源

码中。下面分别举例说明用法：
        if (I = 42) then                                //错误-括号无意义
        if (I = 42) or (J = 42 ) then   //正确-括号必须
保留字和关键字
Object Pascal语言的保留字和关键字将总是完全小写的。
过程和函数(惯例)
一、    命名/格式
通常名字应该总是每个单词开头字母大写，这样有助于程序的易读性。下面是一个过程

命名格式错误的例子：
                procedure thisisapoorlyformattedroutinename；
这是一个大写字母适当的常规命名的例子：
                procedure ThisIsMuchMoreReadableRoutineName；
通常起的名字应该和它的内容相关。通常用一个相关的动词作为前缀，例如：
                procedure FormatHardDrive；
通常设置录入的参数变量的过程用单词set作前缀，例如：
                procedure SetUserName；
通常重新获得这一变量的函数使用get作为前缀，例如：
function GetUserName：string；
二、    形参
l       格式化
可能出现多个形参组合在一个语句中：
        procedure Foo(Param1,Param2,Param3,Param4: Integer；Param4: string);

l       命名
所有的形参的名字都是和它的用途相关的，并且参数的名字不要和传进参数的名字重名

。适当地可以用A作为前缀，例如：
        procedure SomeProc(AuserName: string; AuserAge: Integer);
当类中一个属性或字段名作为参数时添加"A"前缀，这只是一个习惯而已。
l       参数的次序
形参的次序按着调用参数的重要性排序。
经常使用（被调用者）参数将放在第一个参数的位置。很少用的参数将从左到右依次排

在后面。
传入参数列表按着从左到右的顺序排在传出参数的前面。
普通参数的按着从左到右顺序排在特殊参数的前面。例如：
SomeProce(Aplanet,Acontinent,Acountry,Astate,Acity)。
例外的顺序规则也是存在的，在事件句柄中当参数是Tobject类型的并命名成Sender通常

放在第一个参数的位置上。
l       常量参数
当record、array、ShortString或者接口类型不需要程序修改的参数，通常在参数前面

标记上const。这有助于编译器通过不许修改参数生成高效率的执行代码。
如果其他类型的参数也不许程序修改则可以任意标记成const。尽管这可能不影响效率，

但它却向程序的调用者提供了关于参数的详细信息。
l       命名冲突
当两个单元都包含有相同名字的过程或函数，那么调用的函数是引用子句中最后单元中

的。为了避免引用子句的模糊性，可以在调用的方法前加上单元名字作为前缀，例如：

        SysUtils.FindClose(SR);
或者
        Windows.FindClose(Handle);
变量
一、    变量命名和格式：
变量的名字都将被赋予意味深长的意义。
循环控制变量通常被赋以一个单字符的名字，像I，J，或者K。它也可以使用更有意义的

名字，像UserIndex。
布尔型变量必须清楚地表示出它等于True和False时的意义。
二、    局部变量：
在函数内部使用的局部变量的用法和命名同所有其它的变量。临时变量可适当地命名。

如果需要，局部变量的初始化将在进入程序段前进行。局部的AnsiString变量自动初始

化成空串，局部interface和dispinterface类型的变量自动初始化成空，局部Variant和

OleVariant类型的变量被初始化成Unassigned。
三、    全局变量的使用：
全局变量是不建议使用的。然而，如果真的需要也是可以使用的。在这种情况下，你要

确认全局变量的有效使用范围。例如，一个全局变量可能只在一个单独单元的实现部分

有效。
全局数据被多个单元使用应该把它们放到一个公共的单元中使用。
全局数据可能在var部分被直接用一个变量进行初始化。记住所有的全局数据都自动地初

始化为零，所以不要初始化全局变量为"空"，像0，nil，''，Unassigned，等等。这样

做的原因是自动初始化的全局数据在可执行文件中部占用空间。初始化为零的数据的存

储方法在一个"virtual"数据段，它只在程序启动时才在内存中分配的。初始化成非零的

全局数据占用磁盘上可执行文件的空间。
类型
l       大写习惯
类型名是关键字的全部用小写字母。Win32 API类型通常全部是大写字母，你可以沿用W

indow.pas或其他API单元的类型名习惯。对于其他的变量名称，第一个字母应该大写，

并且其余的单词像驼峰一样交替开头字母大写。例如下面的一些例子：
var
  MyString: string;   // 关键字
  WindowHandle: HWND; // Win32 API 类型
  I: Integer;         // System单元中定义的类型标识
l       浮点类型：
Real类型的使用是不提倡的，因为它只是为了向后兼容以前Pascal代码的。需要用浮点

数时通常使用Double。同样，Double也是处理器和总线支持的指令，是优化了的IEEE定

义的标准数据格式。只有在确实需要比Double更大范围的数时使用Extended。Extended

是Intel芯片的特殊类型并且Java不支持该类型。只有在浮点型变量的物理字节大小非常

重要的情况下（例如当使用其它语言的动态连接库时）才使用Single类型。
l       枚举类型：
枚举类型的名字一定要能清楚地表达它所代表的意义。这个类型名一定要在它的类型声

明前加上T作为前缀。枚举类型的标识符列表应该包含2-4个小写字符前缀用来描述类型

的名字，例如：
TSongType = (stRock, stClassical, stCountry, stAlternative, stHeavyMetal, st

RB);
枚举类型的变量实例将被赋以类型名去掉T前缀后的名字（SongType），如果不这样就把

变量名添加成更能表现出其意义的样子，如FavoriteSongType1，FavoriteSongType2，

等等。
l       Variant和OleVariant类型：
Variant和OleVariant类型通常也是不提倡使用的，但是只有在程序运行时不知道数据类

型时就需要这种类型了，它经常出现在COM和数据库编程中。例如在以COM技术为基础的

Automation和ActiveX控制程序设计中使用OleVariant类型，在非COM程序设计中使用Va

riant类型。这是因为一个Variant变量可以有效地存储Delphi本身的字符串变量（就像

一个字符串变量一样），而OleVariant变量把所有的字符串变量转化为Ole 字符串变量

（WideChar字符串），并且还不提供拷贝计数的功能。
结构类型
l       数组类型：
数组类型声明的名字必须完全表示出数组的意义。这个定义的类型名必须用一个T字母作

为前缀。如果声明的是一个数组类型指针，那么必须用字母P作为前缀并且要直接声明在

类型定义的前面，例如：
type
  PCycleArray = ^TCycleArray;
  TCycleArray = array[1..100] of integer;
在实际应用中，数组类型变量实例将应被赋以除了T前缀以外和类型名相同的名称。
l       记录类型：
记录类型应该起一个能充分代表它意义的名字。类型声明必须用字母T作为前缀。如果声

明一个记录指针类型，它必须用字母P作为前缀并且直接声明在记录类型声明之前。类型

声明的成员可以随意地如下例子排在一列上：
type
  PEmployee = ^TEmployee;
  TEmployee = record
    EmployeeName: string
    EmployeeRate: Double;
  end;
语句
l       if语句：
大量的语句通常放在if/then/else语句的then子句中，而很少放在else子句中。
在尽可能的情况下最好能用case语句代替if语句。
不要使if语句嵌套层次超过5层。创建一个简洁、明了的代码。
不要在一个if语句中使用多余的括号。
如果一个if语句的测试条件有多条时，各条件应按着条件运算简单到复杂的顺序从左到

右地依次排列。这允许编译器在编译你的代码时可以实现逻辑判断时走捷径。例如，如

果 Condition1 比Condition2快，并且Condition2比Condition3快，那么if语句的结构

如下：
    if Condition1 and Condition2 and Condition3 then
l       case语句：
2       概括介绍
在case语句中的情况语句必须是数值型或字符型常量中的任意个。
每个情况语句中的代码最好不要超过4到5行。如果语句的实现真的很复杂，建议把它放

到一个单独的过程或函数中。
只有在确实是默认值或监测错误时才使用case语句的else子句。
2       格式化
case语句格式化规则和其他结构一样，需要注意缩进和命名习惯。
l       while语句：
不提倡在while循环中使用Exit过程；实在迫不得已，你可以用循环条件跳出这个循环。

所有的为了循环的初始化代码应直接放在进入循环之前并不要被其他无关的语句隔开。

l       for语句：
当while语句执行条件是一个已知增量数值时可以使用for语句实现。
l       repeat语句：
repeat语句和while循环语句类似并且格式要求也同于一般的语句规则。
l       with语句：
2       概括介绍
尽量少地使用with语句并且千万谨慎地使用。尽量避免过度使用with语句，而且小心使

用多对象、记录在with语句中。例如：
        with Record1，Record2  do
这样的语句能把扰乱程序员并很容易增加对错误检测的困难。
2       格式化
with语句格式化规则和本文档其他缩进和命名规则相同。
异常结构处理
l       概括：
异常处理被广泛应用在错误恢复和资源保护上。这就要在资源分配的情况下使用，必须

使用try..finally来保证资源的释放。异常处理要放在单元的资源分配、释放，初始化

、结束或者对象的创建和摧毁。
l       try..finally的使用：
如果可能的话，每个构造函数的分配都配以try..finally的子句。例如下面的代码可能

导致发生错误：
SomeClass1 := TSomeClass.Create
SomeClass2 := TSomeClass.Create;
try
  { do some code }
finally
  SomeClass1.Free;
  SomeClass2.Free;
end;
要紧跟着分配之后使用：
SomeClass1 := TSomeClass.Create
try
  SomeClass2 := TSomeClass.Create;
  try
    { do some code }
  finally
    SomeClass2.Free;
  end;
finally
  SomeClass1.Free;
end;
l       try..except的使用：
只有在异常被引发时你想执行一些任务时才使用try..except。通常你不需要用try..ex

cept在屏幕上显示一个简单的错误信息，因为这些已经被程序的上下文Application对象

完成了。如果你想在你的except子句处理完一些任务后调用默认的异常处理，可以使用

raise重新引发异常的下一个处理。
l       try..except..else的使用：
和try..except一起的else子句的使用是不推荐的，因为它会阻止所有的异常，这其中有

些可能是你恰好没想到的。
类
命名/格式
类的名称应该包含类的功能的意义。类的名字必须有一个T作为前缀来标示这是一个类的

定义。例如：
type
          Tcustomer = class(Tobject)
类的实例的名字应该和类的名字相匹配并且没有T前缀。
例如：
  var
Customer：Tcustomer;
注意：看"Component Type Naming Standards"已得到更多的内容。
域：(field)
类的域的名字应该和变量标示一样，只是要加上前缀F已表示他表示的是域的名字。
可见度
所有的域都应该是私有的。外界的类可以通过访问属性（property）来访问域。
方法：(methods)
        命名/格式
        方法命名和过程（procedure）函数（function）一样在一个文档里。
静态方法的使用
        在你不想使你的方法被后代覆盖（override）的时候，你可以使用静态的方法
。
虚/动态方法的使用
        在你想让你的方法被后代使用的时候，你可以使用虚方法（virtual methods）
。�
态
方法，应该只被用在那些子代（直接或者间接）非常多的类上。比如，一个类包含了一

个很少发生的覆盖的方法，并且100个子代的类可以使这个方法动态化以减少100个子代

的内存。（译者注：如果不被声明成动态的方法，那么在每一个子类中都会静态的产生

方法的内存）。
纯虚方法的使用
        不要在可能被创建的类上使用纯虚方法，如果你在类中使用纯虚方法，那么这
个类
Ω�
是永远不能被创建的基类。
访问属性的方法
        所有的访问方法必须在protected或者private部分声名。
        访问属性的方法的命名规则和过程函数的一样，读过程应该有一个Get做为前缀
，�
过
程应该有一个Set的前缀。并且写过程的参数应该叫做Value，它的类型应该和声明的类

型一致。
TSomeClass = class(TObject)
private
  FSomeField: Integer;
protected
  function GetSomeField: Integer;
  procedure SetSomeField( Value: Integer);
public
  property SomeField: Integer read GetSomeField write SetSomeField;
end;
属性
        属性为私有的field服务，并且和field的命名一致只是没有F的前缀。
属性应该是个名词而不是动词，属性描述数据，方法描述动作。
        数组属性的名字应该是多个的，普通的属性的名字应该是单个的。
使用访问方法
        尽管并没有做要求，但是使用最少量的"写方法"来访问代表私有域的属性。
文件
        工程文件应该给以描述性的名字，比如"天威电脑部显示屏控制系统软件"叫做
：TW
ed
Ctrl.dpr.三洋冷链的ims控制系统:：ims.dpr
窗体文件
        窗体文件应该描述窗体的目的，并且有前缀Frm,（在使用frame的工程里，在天
威�
脑
部范围内，应该用Frm_表示frame文件。用Form前缀表示窗体文件。
Data Module Files
        一个Data module 应该有后缀DM.例如：一个Customers Data module 应该有一
个�
件
名CustomersDM.dfm.
Remote Data Module Files
        命名，一个远程的Data module 应该有后缀RDM.
单元文件（Unit Files）

--
※ 来源:·哈工大紫丁香 bbs.hit.edu.cn·[FROM: 202.118.248.81]
--
※ 转载:．哈工大紫丁香 bbs.hit.edu.cn．[FROM: 202.118.245.174]