1、Delphi 编码规范Sandy- 2 -目 录Delphi 编码规范 .- 1 -一、序言 .- 1 -二、通用源代码格式规则 .- 1 -2.1 缩格 .- 1 -2.2 页边空格 .- 1 -2.3 BeginEnd 配对 .- 1 -三、Object Pascal .- 2 -3.1 括号 .- 2 -3.2 保留字和关键字 .- 2 -3.3 过程和函数 .- 3 -3.3.1 命名/格式化 .- 3 -3.3.2 形式参数 .- 3 -3.4 变量 .- 4 -3.4.1 变量的命名和格式 .- 4 -3.4.2 局部变量 .- 5 -3.4.3 全局变量的使用 .- 5 -3.5
2、 类型 .- 5 -3.5.1 大写约定 .- 5 -3.5.2 结构类型 .- 6 -3.6 语句 .- 7 -3.6.1 if 语句 .- 7 -3.6.2 case 语句 .- 7 -3.6.3 while 语句 .- 8 -3.6.4 for 语句 .- 8 -3.6.5 repeat 语句 .- 8 -3.6.6 with 语句 .- 8 -3.7 结构异常处理 .- 8 -3.7.1 一般话题 .- 8 -3.7.2 tryfinally 的使用 .- 9 -3.7.3 tryexcept 的使用 .- 10 -3.7.4 tryexceptelse 的使用 .- 10 -3.8
3、类 .- 10 -3.8.1 命名和格式 .- 10 -3.8.2 域 .- 10 -3.8.4 属性 .- 12 -四、文件 .- 12 -4.1 工程文件 .- 12 -4.1.1 命名 .- 12 -4.2 窗体文件 .- 12 -4.2.1 命名 .- 12 -4.3 数据模板文件 .- 12 -4.3.1 命名 .- 12 - 3 -4.4 远端数据模板文件 .- 13 -4.4.1 命名 .- 13 -4.5 Unit 文件 .- 13 -4.5.1 通用 Unit 结构 .- 13 -4.5.3 数据模板单元 .- 14 -4.5.4 一般目的单元 .- 14 -4.5.5 组件
4、单元 .- 14 -4.6 文件头 .- 14 -五、窗体和数据模板 .- 15 -5.1 窗体 .- 15 -5.1.1 窗体类型命名标准 .- 15 -5.1.2 窗体实例命名标准 .- 15 -5.1.3 自动创建窗体 .- 15 -5.1.4 模式窗体实例化函数 .- 15 -5.2 数据模板 .- 17 -5.2.1 数据模板命名标准 .- 17 -5.2.2 数据模板实例命名标准 .- 18 -六、包 .- 18 -6.1 使用运行包和设计包的比较 .- 18 -6.2 文件命名标准 .- 18 -七、组件 .- 19 -7.1 用户自定义组件 .- 19 -7.2 组件单元 .-
5、 19 -7.3 使用注册单元 .- 19 -7.4 组件实例命名约定 .- 19 -7.5 组件的前缀 .- 20 -7.6 Standard 页 .- 20 -7.7 Additional 页 .- 21 -7.8 Win32 页 .- 21 -7.9 System 页 .- 22 -7.10 Internet 页 .- 22 -7.11 Data Access 页 .- 24 -7.12 Data Controls 页 .- 24 -7.13 Decision Cube 页 .- 25 -7.14 QReport 页 .- 25 -7.15 Dialogs 页 .- 26 -7.16 W
6、in3.1 页 .- 26 -7.17 Samples 页 .- 27 -7.18 ActiveX 页 .- 27 -7.19 Midas 页 .- 28 - 1 -Delphi 编码规范一、序言本文档详述了在 Delphi 下进行编程的代码编写标准。在 Delphi 开发者指南 中包含本文档的目的在于阐述一种方法，通过该方法，开发小组可以在他们所编写的代码中保持一贯的风格。这样做的目的是使在开发小组中的每一个程序员都可以明白其他程序员的代码。这有助于提高代码编写的可读性和使用的一贯性。二、通用源代码格式规则2.1 缩格缩格是指在每一级有两个空格。不要在源代码中保留 tab 字符，这是因为 t
7、ab 字符会随着不同用户的不同设置和不同的资源管理工具（打印、文档、版本控制等）而代表不同的宽度。你可以通过关闭 Environment 选项对话框中 Editor 页上的“Use tab character”和“Optimal fill”检查框（通过 Tools|Environment）来禁止保存 tab 字符。2.2 页边空格页边空格会被设置成 80 字符宽。通常，源码不会超出这个边界，但这个方针会有一些弹性。不管是否有可能，那些超出到另一行的语句会在一个逗号或其他操作符之后与前面的语句相连。当一个语句被打断相连时，它应比原来的那一行语句缩进两个字符。2.3 BeginEnd 配对Begi
8、n 子句应写在独立的一行。例如，下面第一行是错误的写法而第二行是正确的。for I := 0 to 10 do begin /错误， begin 同 for 在同一行for I := 0 to 10 do /正确， begin 出现在独立的一行begin- 2 -这个规则的例外是当 begin 子句的出现是作为一个 else 子句的一部分参考例子：if some statement thenbeginendelse beginend;end 语句永远出现在独立的一行。当 begin 语句不是一个 else 子句的一部分时，相应的 end 语句永远缩进到与 begin 部分相对应的位置。三、Ob
9、ject Pascal3.1 括号永远不要在括号与括号之间的字符中间留下空格。下面的例子示范了错误的与正确地使用括号中的空格：CallProc( Aparameter ); /错误CallProc(Aparameter); /正确永远不要在一个语句中使用不必要的括号。括号只应在源代码中需要的地方使用。以下的例子示范了错误和正确的使用：if (I = 42) then /错误 多余的括号if (I = 42) or (J = 42) then /正确 需要括号3.2 保留字和关键字Object Pascal 保留字和关键字永远是全部小写。- 3 -3.3 过程和函数3.3.1 命名/格式化过程的
10、名字永远应该以大写的字母开头并且中间错落分明以增加代码的可读性。下面是一个不正确格式的过程名称：procedure thisisapoorlyformattedroutinename; /错误下面是一个合适的大小写过程名称：procedure ThisIsMuchMoreReadableRoutineName; /正确过程的名称应该同它的内容相符。一个会导致某个行为的过程应以动词开头。例如：procedure FormatHardDrive;一个用于设置输入参数的过程应以单词 set 作为前缀，例如：procedure SetUserName(aName: string);一个用来接收某个值的
11、过程应以单词 get 作为前缀，例如：function GetUserName: string;3.3.2 形式参数3.3.2.1 格式化如果有的话，相同类型的形参应合并在一个语句中：procedure Foo(Param1, Param2, Param3 : Integer; Param4 : string);3.3.2.2 命名所有形参的名字应是十分符合它们所代表的意义，特别是应该以传送到过程中的标志符的名称为基础。一个好的参数名称应以字符 A 为前缀 例如：procedure SomeProc(AuserName : string; AuserAge : integer);“A”前缀按约
12、定表示该参数的名称是与类类型中的一个属性或域的名称相对应的。3.3.2.3 参数的排序- 4 -下面的形参的顺序重点说明了注册者调用约定调用的好处。 最常用的参数应放在第一位，其它的参数应按从左到右的顺序排列。 输入参数列表应放在输出参数列表的左边。 将通用的参数放在特殊参数的左边，例如：procedure SomeProc(Aplanet, AContinent, Acountry, Astate, Acity) 排序可能有些例外，如事件的处理。类型为 TObject 的 Sender 参数经常放在第一位。3.3.2.4 常量参数当一个参数为记录型、数组类型、ShortString、接口类型
13、等并且在过程中不被改变时，这些参数应设为常量标记。这样编译器会产生更加有效率的代码。而过程中另外一些非变参数也可常量来传送。尽管这样做没有产生任何效果和提高效率，这将会给调用过程的使用者提供更多的信息。3.3.2.5 名称的冲突当使用拥有两个名称相同的过程的两个单元时，如果你调用该过程时，在 uses 子句中排在后面的单元中的过程将会被调用。为了解决这种“在 uses 子句上的模糊”冲突，要在调用该过程时写上相关的单元的前缀，例如：sysUtile.FindClose(SR);或windows.FindClose(Handle);3.4 变量3.4.1 变量的命名和格式变量的命名应与使用它们的
14、目的相符。循环控制变量应采用一个单独的字符作为名字，比如 I，J，或 K，也可以采用更加有意义的名字，比如 UserIndex。逻辑变量的名字应能充分表达准确的真或假的意思。- 5 -3.4.2 局部变量一个过程中的局部变量应遵循所有其它变量的使用和命名约定。临时变量的取名应合理。如果必须的话，在一进入过程就应初始化局部变量。局部的 AnsiString 变量会自动初始化为一个空的字符串。局部接口和派分接口类型变量将会自动初始化为 nil，并且局部变数和 ole 变数类型变量会自动初始化为 Unassigned3.4.3 全局变量的使用使用全局变量是不推荐的。但是，在某些时候还是必须使用，而且
15、它们也只应在必须使用的时候才使用。在这种时候，你应努力只在一段上下文范围内使用全局变量。例如，一个全局变量只应在一个单元的 implemntation 部分内是全局的。如果打算在多个单元类使用全局数据，你应将它们移到一个公共的单元中然后被其它所有单元使用。全局变量可以在 var 子句中直接初始化为一个值。记住，所有的全局数据会自动初始化为0,因此不要将全局变量初始化为一个“空”值比如 0、nil 、Unassigned 、等等。这样做的一个理由是因为零初始化的全局数据在 exe 文件中不会占据任何空间。零初始化数据被存储在一个虚拟的数据段，它在应用程序启动后被分配在一段内存中。非零初始化的全局
16、数据在硬盘的 exe 文件占用空间。3.5 类型3.5.1 大写约定如果类型的名字是保留字，那么它应全部小写。Win32 API 类型通常全部大写，并且你必须遵循在 Windows.pas 或其他 API 单元中的详细类型名称的约定。对于其他变量名字，第一个字母应为大写，而其他字母应错落有致。下面是一些例子：varMyString : string; /保留字WindowHandle : HWND; /Win32 API 类型I : Integer; /在 System 单元中引进的类型标识符3.5.1.1 浮点指针类型不推荐使用 Real 类型，因为它的存在只是为了向前兼容早期的 Pasca
17、l 代码。在通常情况下用 Double 来实现浮点指针的需要。并且，Double 对处理器和总线而言是做了最优- 6 -化处理的，它也是 IEEE 中定义的标准数据格式。只有当需要的范围超出 Double 所定义的范围时才使用 Extended。 Extended 是 intel 定义的类型且在 Java 中不支持。只有当浮点指针变量的实际字节大小有其意义时才使用 Single。（比如当使用另一种语言的DLLs 时）。3.5.1.2 枚举类型枚举类型的名字需符合使用该类型的目的。该类型的名字需以字符 T 为前缀，以表明这是一个类型。枚举类型中的标识符列表必须包含两个或三个字符的前缀来对应于该枚
18、举类型的名字 例如：TsongType = (stRock, stClassical, stCountry, stAlternative, stHeavyMetal, stRB);一个枚举类型的实例的名字应与不要前缀的枚举类型（SongType）相同，除非有更好的原因来赋予该变量更特殊的名字，比如：FavoriteSongType1,FavoriteSongType2 等等。3.5.1.3 Variant 和 ole Variant 类型通常不建议使用 Variant 和 OleVariant 类型。但在只有运行时刻才能知道数据类型的程序中必须使用该类型，这种情形多出现在 COM 和数据库开发
19、中。Ole Variant 使用在以COM 为基础的编程中例如自动化和 ActiveX 控制，而 Variant 使用在非 COM 的编程中，这是因为 Variant 可以十分有效地存储本地 Delphi 字符串（同一个字符串变量一样），但 Ole 变数会将所有的字符串转换为 Ole 字符串（WideChar 字符串）并且并不实例运算 它们永远拷贝。3.5.2 结构类型3.5.2.1 数组类型数组类型的名字需符合它们使用的目的。该类型的名字必须加以前缀 T。如果须声明该数组类型的指针，那么该指针需加以前缀 P 而且应立即声明在该数组声明的前面。例如：typePCycleArray = TCyc
20、leArray;TCycleArray = array1100 of integer;在实际应用中，数组的变量实例的名称应是其类型的名字去掉前缀 T。3.5.2.2 记录类型- 7 -记录类型的名字应符合使用它们的目的。其类型的声明应加以前缀 T。如果要声明该记录类型的指针，就应加以前缀 P 并且应紧靠在类型声明的前面声明。例如：typePEmployee = TEmployee;TEmployee = recordEmployeeName : string;EmployeeRate : Double;end;3.6 语句3.6.1 if 语句在 if/then/else 语句中最常发生的行为
21、应放在 then 子句中，而其它发生可能性较小的行为应放在 else 子句中。尽量避免使用嵌套的 if 语句，在这种情形下应用多个 if 语句来判断各种可能。不要使用 if 嵌套超过五级深度。应使代码编写得更加清晰、明了。不要在 if 语句中使用不必要的圆括号。如果在 if 语句中有多个条件需测试，这些条件应按计算强度由少到多的顺序从左到右排列。这样做能使编译器在编译代码时获得布尔估算逻辑的捷径，从而使你的代码获得最佳的优化。举例来说，如果条件 1 快过条件 2，而条件 2 快过条件 3，那么在 if 语句中的排列应是：if 条件 1 and 条件 2 and 条件 3 then3.6.2 case 语句3.6.2.1 一般性话题在一个 case 语句中的各个独立的单元应以数字或字母顺序排列。每一个 case 单元的动作行为应保持简单而不应该超过四到五行代码。如果所要执行的动作过于复杂应采用独立的过程或函数。
