收藏 分享(赏)

Delphi编码及注释规范.doc

上传人:ysd1539 文档编号:7200653 上传时间:2019-05-09 格式:DOC 页数:34 大小:317.50KB
下载 相关 举报
Delphi编码及注释规范.doc_第1页
第1页 / 共34页
Delphi编码及注释规范.doc_第2页
第2页 / 共34页
Delphi编码及注释规范.doc_第3页
第3页 / 共34页
Delphi编码及注释规范.doc_第4页
第4页 / 共34页
Delphi编码及注释规范.doc_第5页
第5页 / 共34页
点击查看更多>>
资源描述

1、北京新网医讯技术有限公司Delphi 程序编码及注释规范V1.02011/3/14北京新网医讯技术有限公司 电话:010-62077491 010- 地址:北京西城黄寺大街 24 号明湖大厦 A201-205 邮政编码:100011- 2 -目 录Delphi 程序员代码编写标准 .- 1 -一、序言 .- 1 -二、通用源代码格式规则 .- 1 -2.1 缩格 - 1 -2.2 页边空格 - 1 -2.3 BeginEnd 配对 .- 2 -三、Object Pascal .- 2 -3.1 括号 - 2 -3.2 保留字和关键字 - 3 -3.3 过程和函数(例程) - 3 -3.3.1

2、命名/格式化 - 3 -3.3.2 形式参数 .- 3 -3.4 变量 - 5 -3.4.1 变量的命名和格式 .- 5 -3.4.2 局部变量 .- 5 -3.4.3 全局变量的使用 .- 5 -3.5 类型 - 5 -3.5.1 大写约定 .- 5 -3.5.2 结构类型 .- 6 -3.6 语句 - 7 -3.6.1 if 语句 .- 7 -3.6.2 case 语句 .- 8 -3.6.3 while 语句 .- 8 -3.6.4 for 语句 .- 8 -3.6.5 repeat 语句 - 8 -3.6.6 with 语句 .- 8 -3.7 结构异常处理 - 9 -3.7.1 一般

3、话题 .- 9 -3.7.2 tryfinally 的使用 - 9 -3.7.3 tryexcept 的使用 - 10 -3.7.4 tryexceptelse 的使用 - 10 -3.8 类类型 - 10 -3.8.1 命名和格式 .- 10 -3.8.2 域 .- 11 -3.8.4 属性 .- 12 -四、文件 .- 12 -4.1 工程文件 - 12 -4.1.1 命名 .- 12 -4.2 窗体文件 - 12 -4.2.1 命名 .- 12 -4.3 数据模板文件 - 13 -4.3.1 命名 .- 13 -北京新网医讯技术有限公司 电话:010-62077491 010- 地址:北

4、京西城黄寺大街 24 号明湖大厦 A201-205 邮政编码:100011- 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 构件单元 .- 14 -4.6 文件头 - 15 -五、窗体和数据模板 .- 15 -5.1 窗体 - 15 -5.1.1 窗体类型命名标准 .- 15 -5.1.2 窗体实例命名标准 .- 15 -5.1.3 自动创建窗体 .- 16 -5.1.4 模式窗体实例化函数

5、 .- 16 -5.2 数据模板 - 18 -5.2.1 数据模板命名标准 .- 18 -5.2.2 数据模板实例命名标准 .- 18 -六、包 .- 18 -6.1 使用运行包和设计包的比较 - 18 -6.2 文件命名标准 - 18 -七、构件 .- 19 -7.1 用户自定义构件 - 19 -7.2 构件单元 - 19 -7.3 使用注册单元 - 19 -7.4 构件实例命名约定 - 20 -7.5 构件的前缀 - 20 -7.6 Standard 页 - 20 -7.7 Additional 页 .- 21 -7.8 Win32 页 .- 22 -7.9 System 页 - 22 -

6、7.10 Internet 页 .- 23 -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 Win3.1 页 - 27 -7.17 Samples 页 - 27 -7.18 ActiveX 页 - 28 -7.19 Midas 页 - 28 -8注释规范 .- 28 -81 修改历史记录 - 29 -82 新增代码行 - 29 -83 删除代码行 - 29 -北京新网医讯技术有限公司 电话

7、:010-62077491 010- 地址:北京西城黄寺大街 24 号明湖大厦 A201-205 邮政编码:100011- 4 -84 修改代码行 - 29 -北京新网医讯技术有限公司 电话:010-62077491 010- 地址:北京西城黄寺大街 24 号明湖大厦 A201-205 邮政编码:100011- 1 -Delphi 编码及注释规范一、序言本文档详述了在 Delphi 下进行编程的代码编写标准。在通常情况下,本文档遵循“取消”式格式的指引方针,该方针由 Borland 国际通过一些例外来使用。在 Delphi 开发者指南 中包含本文档的目的在于阐述一种方法,通过该方法,开发小组可

8、以在他们所编写的代码中保持一贯的风格。这样做的目的是使在开发小组中的每一个程序员都可以明白其他程序员的代码。这有助于提高代码编写的可读性和使用的一贯性。本文档并不意味着包含了所有存在于代码中的标准。但是,它的内容已足够帮你起个好头。你可以自由的增加修改这些标准来满足你的需要。我们不赞成你偏离这些由 Borland 开发人员所使用的标准太远。我们推荐这么做是因为一旦有新的程序员加入到你的开发小组中,而他们最喜欢和最熟悉的是 Borland 的标准。象大多数代码标准文档,本文档也会根据需要进行改动。因此,你可以到 中找到最新的更新版本。本文档不包括 用户接口标准 。本文档是独立的但也是同样重要的

9、。已经有足够的第三方书籍和Microsoft 文档包括了另外一些指导方针,而我们决定并不复制这些信息,但我们会指引你到 Microsoft Developers Network 和一些资源,在那儿可以找到你所需的信息。二、通用源代码格式规则2.1 缩格缩格是指在每一级有两个空格。不要在源代码中保留 tab 字符,这是因为 tab 字符会随着不同用户的不同设置和不同的资源管理工具(打印、文档、版本控制等)而代表不同的宽度。你可以通过关闭 Environment 选项对话框中 Editor 页上的“Use tab character”和“Optimal fill”检查框(通过 Tools|Envi

10、ronment)来禁止保存 tab 字符。2.2 页边空格页边空格会被设置成 80 字符宽。通常,源码不会超出这个边界,但这个方针会有一些弹性。不管是否有可能,那些超出到另一行的语句会在一个逗号或其他操作符之后与前面的语句相连。当一个语句被打断相连时,它应比原来的那一行语句缩进两个字符。北京新网医讯技术有限公司 电话:010-62077491 010- 地址:北京西城黄寺大街 24 号明湖大厦 A201-205 邮政编码:100011- 2 -2.3 BeginEnd 配对Begin 子句应写在独立的一行。例如,下面第一行是错误的写法而第二行是正确的。for I := 0 to 10 do b

11、egin /错误, begin 同 for 在同一行for I := 0 to 10 do /正确, begin 出现在独立的一行begin这个规则的例外是当 begin 子句的出现是作为一个 else 子句的一部分参考例子:if some statement thenbeginendelse beginsomeOtherStatement;end;end 语句永远出现在独立的一行。当 begin 语句不是一个 else 子句的一部分时,相应的 end 语句永远缩进到与 begin 部分相对应的位置。三、Object Pascal3.1 括号永远不要在括号与括号之间的字符中间留下空格。下面的例

12、子示范了错误的与正确地使用括号中的空格:CallProc( Aparameter ); /错误CallProc(Aparameter); /正确北京新网医讯技术有限公司 电话:010-62077491 010- 地址:北京西城黄寺大街 24 号明湖大厦 A201-205 邮政编码:100011- 3 -永远不要在一个语句中使用不必要的括号。括号只应在源代码中需要的地方使用。以下的例子示范了错误和正确的使用:if (I = 42) then /错误 多余的括号if (I = 42) or (J = 42) then /正确 需要括号3.2 保留字和关键字Object Pascal 保留字和关键字

13、永远是全部小写。3.3 过程和函数(例程)3.3.1 命名/格式化例程的名字永远应该以大写的字母开头并且中间错落分明以便于可读性。下面是一个不正确格式的过程名称:procedure thisisapoorlyformattedroutinename;下面是一个合适的大小写例程名称的例子:procedure ThisIsMuchMoreReadableRoutineName;例程的名称应该同它的内容相符。一个会导致某个行为的例程应以动词开头。例如:procedure FormatHardDrive;一个用于设置输入参数的例程应以单词 set 作为前缀,例如:procedure SetUserNa

14、me;一个用来接收某个值的例程应以单词 get 作为前缀,例如:procedure GetUserName : string;3.3.2 形式参数3.3.2.1 格式化如果有的话,相同类型的形参应合并在一个语句中:procedure Foo(Param1, Param2, Param3 : Integer; Param4 : string);北京新网医讯技术有限公司 电话:010-62077491 010- 地址:北京西城黄寺大街 24 号明湖大厦 A201-205 邮政编码:100011- 4 -3.3.2.2 命名所有形参的名字应是十分符合它们所代表的意义,特别是应该以传送到例程中的标志符

15、的名称为基础。一个好的参数名称应以字符 A 为前缀 例如:procedure SomeProc(AuserName : string; AuserAge : integer);“A”前缀按约定表示该参数的名称是与类类型中的一个属性或域的名称相对应的。3.3.2.3 参数的排序下面的形参的顺序重点说明了注册者调用约定调用的好处。 最常用的参数应放在第一位,其它的参数应按从左到右的顺序排列。 输入参数列表应放在输出参数列表的左边。 将通用的参数放在特殊参数的左边,例如:procedure SomeProc(Aplanet, AContinent, Acountry, Astate, Acity)

16、排序有可能有些例外,比如事件的处理。类型为 TObject 的 Sender 参数经常放在第一位。3.3.2.4 常量参数当一个参数为记录型、数组类型、ShortString、或接口类型并且在例程中不被改变时,这些参数应做上常量标记。这样做会让编译器更加有效率的产生有关这些不改变的参数的代码。而例程中另外一些非变参数也可常量来传送。尽管这样做没有产生任何效果和提高效率,这将会给调用例程的使用者提供更多的信息。3.3.2.5 名称的冲突当使用拥有两个名称相同的例程的两个单元时,如果你调用该例程时,在 uses 子句中排在后面的单元中的例程将会被调用。为了解决这种“在 uses 子句上的模糊”冲突

17、,要在调用该例程时写上相关的单元的前缀,例如:sysUtile.FindClose(SR);或windows.FindClose(Handle);北京新网医讯技术有限公司 电话:010-62077491 010- 地址:北京西城黄寺大街 24 号明湖大厦 A201-205 邮政编码:100011- 5 -3.4 变量3.4.1 变量的命名和格式变量的命名应以使用它们的目的相符循环控制变量应采用一个单独的字符作为名字,比如 I,J,或 K,也可以采用更加有意义的名字,比如 UserIndex。逻辑变量的名字应能充分表达准确的真或假的意思。3.4.2 局部变量一个过程中的局部变量应遵循所有其它变量

18、的使用和命名约定。临时变量的取名应合理。如果必须的话,在一进入例程就应初始化局部变量。局部的 AnsiString 变量会自动初始化为一个空的字符串。局部接口和派分接口类型变量将会自动初始化为 nil,并且局部变数和 ole 变数类型变量会自动初始化为 Unassigned3.4.3 全局变量的使用使用全局变量是不推荐的。但是,在某些时候还是必须使用,而且它们也只应在必须使用的时候才使用。在这种时候,你应努力只在一段上下文范围内使用全局变量。例如,一个全局变量只应在一个单元的 implemntation 部分内是全局的。如果打算在多个单元类使用全局数据,你应将它们移到一个公共的单元中然后被其它

19、所有单元使用。全局变量可以在 var 子句中直接初始化为一个值。记住,所有的全局数据会自动初始化为0,因此不要将全局变量初始化为一个“空”值比如 0、nil 、Unassigned 、等等。这样做的一个理由是因为零初始化的全局数据在 exe 文件中不会占据任何空间。零初始化数据被存储在一个虚拟的数据段,它在应用程序启动后被分配在一段内存中。非零初始化的全局数据在硬盘的 exe 文件占用空间。3.5 类型3.5.1 大写约定如果类型的名字是保留字,那么它应全部小写。Win32 API 类型通常全部大写,并且你必须遵循在 Windows.pas 或其他 API 单元中的详细类型名称的约定。对于其他

20、变量名字,地一个字母应为大写,而其他字母应错落有致。下面是一些例子:北京新网医讯技术有限公司 电话:010-62077491 010- 地址:北京西城黄寺大街 24 号明湖大厦 A201-205 邮政编码:100011- 6 -varMyString : string; /保留字WindowHandle : HWND; /Win32 API 类型I : Integer; /在 System 单元中引进的类型标识符3.5.1.1 浮点指针类型不推荐使用 Real 类型,因为它的存在只是为了向前兼容早期的 Pascal 代码。在通常情况下用 Double 来实现浮点指针的需要。并且,Double

21、对处理器和总线而言是做了最优化处理的,它也是 IEEE 中定义的标准数据格式。只有当需要的范围超出 Double 所定义的范围时才使用 Extended。 Extended 是 intel 定义的类型且在 Java 中不支持。只有当浮点指针变量的实际字节大小有其意义时才使用 Single。(比如当使用另一种语言的DLLs 时)。3.5.1.2 枚举类型枚举类型的名字需符合使用该类型的目的。该类型的名字需以字符 T 为前缀,以表明这是一个类型。枚举类型中的标识符列表必须包含两个或三个字符的前缀来对应于该枚举类型的名字 例如:TsongType = (stRock, stClassical, st

22、Country, stAlternative, stHeavyMetal, stRB);一个枚举类型的实例的名字应与不要前缀的枚举类型(SongType)相同,除非有更好的原因来赋予该变量更特殊的名字,比如:FavoriteSongType1,FavoriteSongType2 等等。3.5.1.3 变数和 ole 变数类型通常不建议使用变数和 Ole 变数类型。但在只有运行时刻才能知道数据类型的程序中必须使用该类型,这种情形多出现在 COM 和数据库开发中。Ole 变数使用在以 COM 为基础的编程中例如自动化和 ActiveX 控制,而变数使用在非 COM 的编程中,这是因为变数可以十分有

23、效地存储本地 Delphi 字符串(同一个字符串变量一样),但 Ole 变数会将所有的字符串转换为 Ole 字符串(WideChar 字符串)并且并不实例运算 它们永远拷贝。3.5.2 结构类型3.5.2.1 数组类型数组类型的名字需符合它们使用的目的。该类型的名字必须加以前缀 T。如果须声明该数组类型的指针,那么该指针需加以前缀 P 而且应立即声明在该数组声明的前面。例如:北京新网医讯技术有限公司 电话:010-62077491 010- 地址:北京西城黄寺大街 24 号明湖大厦 A201-205 邮政编码:100011- 7 -typePCycleArray = TCycleArray;T

24、CycleArray = array1100 of integer;在实际应用中,数组的变量实例的名称应是其类型的名字去掉前缀 T。3.5.2.2 记录类型记录类型的名字应符合使用它们的目的。其类型的声明应加以前缀 T。如果要声明该记录类型的指针,就应加以前缀 P 并且应紧靠在类型声明的前面声明。例如:typePEmployee = TEmployee;TEmployee = recordEmployeeName : string;EmployeeRate : Double;end;3.6 语句3.6.1 if 语句在 if/then/else 语句中最常发生的行为应放在 then 子句中,而

25、其它发生可能性较小的行为应放在 else 子句中。尽量避免使用嵌套的 if 语句,在这种情形下应用多个 if 语句来判断各种可能。不要使用 if 嵌套超过五级深度。应使代码编写得更加清晰、明了。不要在 if 语句中使用不必要的圆括号。如果在 if 语句中有多个条件需测试,这些条件应按计算强度由少到多的顺序从左到右排列。这样做能使编译器在编译代码时获得布尔估算逻辑的捷径,从而使你的代码获得最佳的优化。举例来说,如果条件 1 快过条件 2,而条件 2 快过条件 3,那么在 if 语句中的排列应是:if 条件 1 and 条件 2 and 条件 3 then北京新网医讯技术有限公司 电话:010-6

26、2077491 010- 地址:北京西城黄寺大街 24 号明湖大厦 A201-205 邮政编码:100011- 8 -3.6.2 case 语句3.6.2.1 一般性话题在一个 case 语句中的各个独立的单元应以数字或字母顺序排列。每一个 case 单元的动作行为应保持简单而不应该超过四到五行代码。如果所要执行的动作过于复杂应采用独立的过程或函数。Case 语句中的 else 子句只有当需要缺省行为或处理错误时才使用。3.6.2.2 格式case 语句应遵循其它结构的缩格和命名约定。3.6.3 while 语句在一个 while 语句中不建议使用 exit 过程来跳出循环,尽量仅使用循环条件

27、来跳出循环。在一个 while 循环中所用的初始化代码应紧靠在进入 while 循环前面出现而不要被其它不相关的语句隔开。任何结束后的处理应在循环之后立即进行。3.6.4 for 语句for 语句只有当循环次数已知的情况下才能取代 while 语句使用。3.6.5 repeat 语句repeat 语句的使用同 while 语句一样,并且遵循同样的通用方针。3.6.6 with 语句3.6.6.1 一般话题with 语句应节省使用,并且带有大量的警告。避免过度使用 with 语句并且在 with 语句中小心使用多个对象、记录等等。例如:with Record1, Record2 do这些事情会使

28、程序员感到困惑并难以发现问题所在。北京新网医讯技术有限公司 电话:010-62077491 010- 地址:北京西城黄寺大街 24 号明湖大厦 A201-205 邮政编码:100011- 9 -3.6.6.2 格式with 语句遵循本文档所说明的命名约定和缩格的格式规则。3.7 结构异常处理3.7.1 一般话题异常的处理大量地使用在错误纠正和资源保护方面。这就是说一旦资源被分配,一个tryfinally 必需加以使用来保证该资源被正确的释放。这种异常的保护也是指在一个单元的 initializition/finalization 或一个对象的 constructor/destructor中进行

29、资源的分配和释放。3.7.2 tryfinally的使用任何情形下,每一次的分配都应跟随一个 tryfinally。举例来说,下面的代码会造成可能的错误:SomeClass1 := TsomeClass.Create;SomeClass2 ;= TsomeClass.Create;try do some code finallySomeClass1.Free;SomeClass2.Free;end;一个更安全更合适的分配过程应是:SomeClass1 := TSomeClass.Create;trySomeClass2 := TsomeClass.Create;try北京新网医讯技术有限公司

30、电话:010-62077491 010- 地址:北京西城黄寺大街 24 号明湖大厦 A201-205 邮政编码:100011- 10 - do some code finallySomeClass2.Free;end;finallySomeClass1.Free;end;3.7.3 tryexcept的使用只有当在异常被触发而你想执行一些任务时才使用 tryexcept。通常,你没有必要为了只是简单地在屏幕上显示一个错误信息而使用 tryexcept 语句,因为这会被Application 对象自动执行。如果你想在 except 子句中执行完一些任务之后调用缺省的异常处理,使用 raise 来

31、重新触发异常到下一个句柄。3.7.4 tryexceptelse的使用tryexcept 中的 else 子句不建议使用,因为它会打断所有的异常包括那些你没有准备的异常。3.8 类类型3.8.1 命名和格式类类型的名称应符合使用它们的目的。类型名字应加以前缀 T 以表明这是一个类型的定义 例如:typeTcustomer = class(TObject)类型的实例通常是没有前缀 T 的类型的名字 例如:varCustomer :Tcustomer;北京新网医讯技术有限公司 电话:010-62077491 010- 地址:北京西城黄寺大街 24 号明湖大厦 A201-205 邮政编码:10001

32、1- 11 -注意:查阅“构件类型的命名标准”来获得更多有关构件命名的信息。3.8.2 域3.8.2.1 命名/格式类的域名遵循与变量标识符同样的约定除了它们应以 F 为前缀,来表明这是一个域的名称。3.8.2.2 可视化所有的域都必需是私有的。想在类的范围之外存取域得通过属性来使用。3.8.3 方法3.8.3.1 命名/格式方法的命名应遵循本文档中有关过程和函数的约定叙述。3.8.3.2 使用静态的方法如果使用一个静态的方法,那么该方法就不能被该类的后代类所继承。3.8.3.3 使用虚拟/动态的方法如果你打算该类的方法能被后代的类所继承就得使用虚拟的方法。只有在该方法有多个继承时(直接的或间

33、接的)才使用动态的方法。例如,一个类类型包含一个可继承的方法,而 100 个后代类要继承这种方法,那么这个方法就会动态地产生为 100 个后代类使用的内存。3.8.3.4 使用抽象的方法如果在一个类中使用抽象的方法,该类就不能被创建。只有在那些永远不会被创建的类中使用抽象的方法。3.8.3.5 属性存取方法所有存取类的方法都只能出现在类的 private 或 protected 部分。属性存取方法的命名应遵循过程和函数的约定规则。读取存取方法(方法读取器)必需以单词 Get 为前缀。写入存取方法(方法写入器)必需以单词 Set 为前缀。方法写入器的参数的名字应为Value,并且它的类型应是它所

34、操作的属性的类型。例如:TSomeClass = class(TObject)private北京新网医讯技术有限公司 电话:010-62077491 010- 地址:北京西城黄寺大街 24 号明湖大厦 A201-205 邮政编码:100011- 12 -FsomeField : Integer;protectedfunction GetSomeField : Integer;procedure SetSomeField(Value : Integer);publicproperty SomeField : Integer read GetSomeField write SetSomeField

35、;end;3.8.4 属性3.8.4.1 命名/格式属性如果是表示为一个私有域的存取器的话,那么它的名字应是它们所操作的域的名字除去解释符 F。属性的名字应是名词,不是动词。属性表示的是数据,而方法表示的是行为。数组类型的名称应为复数。一般情况下属性的名称应为单数。3.8.4.2 使用存取的方法尽管没有要求,但还是建议尽量少地为一个表示私有域的属性而使用写入存取方法。 四、文件4.1 工程文件4.1.1 命名工程文件应取个描述性的名字。例如,Delphi 4 开发者指南错误管理器 的工程名字是:DDGBugs.dpr。一个有关系统信息的程序的名字就应象 SysInfo.dpr。北京新网医讯技术

36、有限公司 电话:010-62077491 010- 地址:北京西城黄寺大街 24 号明湖大厦 A201-205 邮政编码:100011- 13 -4.2 窗体文件4.2.1 命名一个窗体文件的取名应可以描述使用该窗体的目的,并加以后缀 Frm。例如,一个“关于”的窗体的文件名应是 AboutFrm.dpr。主窗体的文件名应是 MainFrm.dpr。4.3 数据模板文件4.3.1 命名数据模板的取名应能表示使用该数据模板的目的,它的名称应加以两个字符的后缀 DM。例如,自定义数据模板的文件名字应为 CustomersDM.dfm。4.4 远端数据模板文件4.4.1 命名远端数据模板的取名应能表

37、示使用该远端数据模板的目的,它的名称应加以三个字符的后缀 RDM。例如,自定义远端数据模板的文件名字应为 CustomersRDM.dfm。4.5 Unit 文件4.5.1 通用 Unit结构4.5.1.1 unit 的名字Unit 文件应取一个可描述性的名字。例如,包含应用程序主窗体的单元应叫做MainFrm.pas。4.5.1.2 uses 子句在 interface 部分的 uses 子句应包含在 interface 部分中的代码所需要的单元。去掉那些 Delphi 可以自动加入到程序中的单元。在 implementation 部分的 uses 子句应只包含在 implementatio

38、n 部分中的代码所需要的单元的名字。去掉不必要的单元。4.5.1.3 interface 部分北京新网医讯技术有限公司 电话:010-62077491 010- 地址:北京西城黄寺大街 24 号明湖大厦 A201-205 邮政编码:100011- 14 -interface 部分应包含只那些其它单元所需要存取类型的定义、变量、过程 /函数的预定义等等。否则,就应放在 implementation 部分定义。4.5.1.4 implementation 部分implementation 部分应包含那些只在本单元中私用的类型定义、变量、过程/函数定义等等。4.5.1.5 initializatio

39、n 部分不要在 initialization 部分放入耗时长的代码,这将使程序的第一个界面出现得比较缓慢。4.5.1.6 finalization 部分在这里要保证释放你在 Initialization 部分所分配的任何资源。4.5.2 窗体单元4.5.2.1 命名一个窗体的单元文件应拥有与它所对应的窗体文件同样的名称。例如,“关于”窗体的单元名称应为 AboutFrm.pas,而主窗体的单元名称应为 MainFrm.pas。4.5.3 数据模板单元4.5.3.1 命名一个数据模板的单元文件应拥有与它所对应的数据模板文件同样的名称。例如,一个自定义数据模板单元的名称应为 CustomersDM

40、.pas。4.5.4 一般目的单元4.5.4.1 命名一般目的单元的取名应符合使用该单元的目的。例如,一个实用程序单元取名为BugUtilities.pas。一个包含全局变量的单元取名为 CustomerGlobals.pas。注意,该单元的名字不能与它的工程中所使用的所有包中的单元的名字相同。不赞成使用一般的或通用的单元名字。北京新网医讯技术有限公司 电话:010-62077491 010- 地址:北京西城黄寺大街 24 号明湖大厦 A201-205 邮政编码:100011- 15 -4.5.5 构件单元4.5.5.1 命名构件单元应放在独立的目录,以将它们同定义构件组或构件集合的单元区分开

41、来。它们要永远同工程在不同的目录。单元名字应同它们的内容相符。注意:查阅“用户定义的构件”部分来获得更多有关构件命名标准的信息。4.6 文件头建议在所有源文件、工程文件、单元等等中使用信息化文件头。一个良好的文件头应包含以下信息:版权 著作的年、月、日 五、窗体和数据模板5.1 窗体5.1.1 窗体类型命名标准窗体类型的取名应能表达使用该窗体的目的。类型定义应加以前缀 T。前缀后面跟随着描述性的名字。最后,应加以 Form 后缀来描述名字。例如,一个“关于”的窗体的类型的名字应为:TAboutFrom = class(TForm);主窗体的定义为:TMainForm = class(TForm

42、);一个用户接入窗体的名字应象:TCustomerEntryForm = class(TForm);北京新网医讯技术有限公司 电话:010-62077491 010- 地址:北京西城黄寺大街 24 号明湖大厦 A201-205 邮政编码:100011- 16 -5.1.2 窗体实例命名标准窗体实例应是没有带前缀 T 的相应类的名字。例如,对应于前面窗体类型而言,其实例的名字应为:类型名称 实例名称TAboutForm AboutFormTMainForm MainFormTCustomerEntryForm CustomerEntryForm5.1.3 自动创建窗体只有主窗体可以是自动创建的除

43、非有其它更好的理由不这样做。所有其它的窗体必需从工程选项对话框中的自动创建列表中移走。查阅以下部分来获得更多的信息。5.1.4 模式窗体实例化函数所有的窗体单元都应包含一个窗体实例化函数,该函数用来创建、设置、模式地显示窗体,并释放窗体。该函数应返回窗体的模式结果。该函数要传递的参数应遵循本文档指定的“参数传递”标准。通过这种方式封装的函数性有助于代码的再利用和维护。该窗体的变量要从单元中移走,并再窗体实例的函数中进行本地式地定义。注意,这就意味着该窗体必需从工程/选项对话框中的自动创建列表中剔除。参考本文档后面的“自动创建窗体”。例如,下面的单元展示了再 GetUserData 窗体中的一个

44、函数。unit UserDataFrm;interfaceuseswindows, Messages, SysUtils, Classes, Graphics, Controls, Forms,Dialogs, StdCtrls;typeTUserDataForm = class(TForm)北京新网医讯技术有限公司 电话:010-62077491 010- 地址:北京西城黄寺大街 24 号明湖大厦 A201-205 邮政编码:100011- 17 -edtUserName : TEdit;edtUserID : TEdit;private Private declarations publi

45、c Public declarations end;function GetUserData(var aUserName : String; var aUserID : Integer) : Word;implementation$R *.DFM function GetUserData(var aUserName : String; var aUserID : Integer) : word;varUserDataForm : TuserDataForm;beginUserDataForm := TuserDataForm.Create(Application);tryUserDataFor

46、m.Caption := Getting User Data;Result := UserDataForm.ShowModal;if (Result = mrOK) then北京新网医讯技术有限公司 电话:010-62077491 010- 地址:北京西城黄寺大街 24 号明湖大厦 A201-205 邮政编码:100011- 18 -beginaUserName := UserDataForm.edtUserName.Text;aUserID := StrToInt(UserDataForm.edtUserID.Text);end;finallyUserDataForm.Free;end;end;end.5.2 数据模板5.2.1 数据模板命名标准数据模板的取名要符合使用该数据模板的目的。类型的定义应加以前缀 T,后面紧接着描述性的名字,最后要加以后缀单词“DataModule”。例如,一个自

展开阅读全文
相关资源
猜你喜欢
相关搜索
资源标签

当前位置:首页 > 企业管理 > 管理学资料

本站链接:文库   一言   我酷   合作


客服QQ:2549714901微博号:道客多多官方知乎号:道客多多

经营许可证编号: 粤ICP备2021046453号世界地图

道客多多©版权所有2020-2025营业执照举报