转至繁体中文版     | 网站首页 | 图文教程 | 资源下载 | 站长博客 | 图片素材 | 武汉seo | 武汉网站优化 | 
最新公告:     敏韬网|教学资源学习资料永久免费分享站!  [mintao  2008年9月2日]        
您现在的位置: 学习笔记 >> 图文教程 >> 软件开发 >> Delphi程序 >> 正文
Delphi程序员代码编写标准指南         ★★★★

Delphi程序员代码编写标准指南

作者:闵涛 文章来源:闵涛的学习笔记 点击数:3150 更新时间:2009/4/23 18:42:42

通常不建议使用变数和Ole变数类型。但在只有运行时刻才能知道数据类型的程序中必须使用该类型,这种情形多出现在COM和数据库开发中。Ole变数使用在以COM为基础的编程中例如自动化和ActiveX控制,而变数使用在非COM的编程中,这是因为变数可以十分有效地存储本地Delphi字符串(同一个字符串变量一样),但Ole变数会将所有的字符串转换为Ole字符串(WideChar 字符串)并且并不实例运算 - 它们永远拷贝。

3.5.2 结构类型

3.5.2.1 数组类型

数组类型的名字需符合它们使用的目的。该类型的名字必须加以前缀T。如果须声明该数组类型的指针,那么该指针需加以前缀P而且应立即声明在该数组声明的前面。例如:
        type
          PCycleArray = ^TCycleArray;
          TCycleArray = array[1…100] of integer;
在实际应用中,数组的变量实例的名称应是其类型的名字去掉前缀T。

3.5.2.2 记录类型

记录类型的名字应符合使用它们的目的。其类型的声明应加以前缀T。如果要声明该记录类型的指针,就应加以前缀P并且应紧靠在类型声明的前面声明。例如:
        type
          PEmployee = ^TEmployee;
          TEmployee = record
            EmployeeName : string;
            EmployeeRate : Double;
          end;

3.6 语句

3.6.1 if 语句

在if/then/else语句中最常发生的行为应放在then子句中,而其它发生可能性较小的行为应放在else子句中。

尽量避免使用嵌套的if语句,在这种情形下应用多个if语句来判断各种可能。

不要使用if嵌套超过五级深度。应使代码编写得更加清晰、明了。

不要在if语句中使用不必要的圆括号。

如果在if语句中有多个条件需测试,这些条件应按计算强度由少到多的顺序从左到右排列。这样做能使编译器在编译代码时获得布尔估算逻辑的捷径,从而使你的代码获得最佳的优化。举例来说,如果条件1快过条件2,而条件2快过条件3,那么在if语句中的排列应是:
         if 条件1 and 条件2 and 条件3 then

3.6.2 case 语句

3.6.2.1 一般性话题

在一个case语句中的各个独立的单元应以数字或字母顺序排列。

每一个case单元的动作行为应保持简单而不应该超过四到五行代码。如果所要执行的动作过于复杂应采用独立的过程或函数。

Case语句中的else子句只有当需要缺省行为或处理错误时才使用。

3.6.2.2 格式

case语句应遵循其它结构的缩格和命名约定。

3.6.3 while 语句

在一个while语句中不建议使用exit过程来跳出循环,尽量仅使用循环条件来跳出循环。

在一个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
这些事情会使程序员感到困惑并难以发现问题所在。

3.6.6.2 格式

with 语句遵循本文档所说明的命名约定和缩格的格式规则。

3.7 结构异常处理

3.7.1 一般话题

异常的处理大量地使用在错误纠正和资源保护方面。这就是说一旦资源被分配,一个try…finally必需加以使用来保证该资源被正确的释放。这种异常的保护也是指在一个单元的initializition/finalization或一个对象的constructor/destructor中进行资源的分配和释放。

3.7.2 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;

3.7.3 try…except的使用

只有当在异常被触发而你想执行一些任务时才使用try…except。通常,你没有必要为了只是简单地在屏幕上显示一个错误信息而使用try…except语句,因为这会被Application对象自动执行。如果你想在except子句中执行完一些任务之后调用缺省的异常处理,使用raise来重新触发异常到下一个句柄。

3.7.4 try…except…else的使用

try…except中的else子句不建议使用,因为它会打断所有的异常包括那些你没有准备的异常。

3.8 类类型

3.8.1 命名和格式

类类型的名称应符合使用它们的目的。类型名字应加以前缀T以表明这是一个类型的定义 - 例如:
type
  Tcustomer = class(TObject)
类型的实例通常是没有前缀T的类型的名字 - 例如:
var
  Customer :Tcustomer;
注意:查阅“构件类型的命名标准”来获得更多有关构件命名的信息。

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 使用虚拟/动态的方法

如果你打算该类的方法能被后代的类所继承就得使用虚拟的方法。只有在该方法有多个继承时(直接的或间接的)才使用动态的方法。例如,一个类类型包含一个可继承的方法,而100个后代类要继承这种方法,那么这个方法就会动态地产生为100个后代类使用的内存。

3.8.3.4 使用抽象的方法

如果在一个类中使用抽象的方法,该类就不能被创建。只有在那些永远不会被创建的类中使用抽象的方法。

3.8.3.5 属性存取方法

所有存取类的方法都只能出现在类的private或protected部分。属性存取方法的命名应遵循过程和函数的约定规则。读取存取方法(方法读取器)必需以单词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;

3.8.4 属性

3.8.4.1 命名/格式

属性如果是表示为一个私有域的存取器的话,那么它的名字应是它们所操作的域的名字除去解释符F。

属性的名字应是名词,不是动词。属性表示的是数据,而方法表示的是行为。

数组类型的名称应为复数。一般情况下属性的名称应为单数。

3.8.4.2 使用存取的方法

尽管没有要求,但还是建议尽量少地为一个表示私有域的属性而使用写入存取方法。

四、文件

4.1 工程文件

4.1.1 命名

工程文件应取个描述性的名字。例如,Delphi 4开发者指南错误管理器 的工程名字是:DDGBugs.dpr。一个有关系统信息的程序的名字就应象 SysInfo.dpr。

4.2 窗体文件

4.2.1 命名

一个窗体文件的取名应可以描述使用该窗体的目的,并加以后缀Frm。例如,一个“关于”的窗体的文件名应是AboutFrm.dpr。主窗体的文件名应是MainFrm.dpr。

4.3 数据模板文件

4.3.1 命名

数据模板的取名应能表示使用该数据模板的目的,它的名称应加以两个字符的后缀DM。例如,自定义数据模板的文件名字应为CustomersDM.dfm。

4.4 远端数据模板文件

4.4.1 命名

远端数据模板的取名应能表示使用该远端数据模板的目的,它的名称应加以三个字符的后缀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子句应只包含在implementation部分中的代码所需要的单元的名字。去掉不必要的单元。

4.5.1.3 interface部分

interface部分应包含只那些其它单元所需要存取类型的定义、变量、过程/函数的预定义等等。否则,就应放在implementation部分定义。

4.5.1.4 implementation部分

implementation部分应包含那些只在本单元中私用的类型定义、变量、过程/函数定义等等。

4.5.1.5 initialization部分

不要在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.pas。

4.5.4 一般目的单元

4.5.4.1 命名

一般目的单元的取名应符合使用该单元的目的。例如,一个实用程序单元取名为BugUtilities.pas。一个包含全局变量的单元取名为CustomerGlobals.pas。

注意,该单元的名字不能与它的工程中所使用的所有包中的单元的名字相同。不赞成使用一般的或通用的单元名字。

4.5.5 构件单元

4.5.5.1 命名

构件单元应放在独立的目录,以将它们同定义构件组或构件集合的单元区分开来。它们要永远同工程在不同的目录。单元名字应同它们的内容相符。

注意:查阅“用户定义的构件”部分来获得更多有关构件命名标准的信息。

4.6 文件头

建议在所有源文件、工程文件、单元等等中使用信息化文件头。一个良好的文件头应包含以下信息:

 版权… 著作的年、月、日…
}

五、窗体和数据模板

5.1 窗体

5.1.1 窗体类型命名标准

窗体类型的取名应能表达使用该窗体的目的。类型定义应加以前缀T。前缀后面跟随着描述性的名字。最后,应加以Form后缀来描述名字。例如,一个“关于”的窗体的类型的名字应为:
        TAboutFrom = class(TForm);
主窗体的定义为:
        TMainForm = class(TForm);
一个用户接入窗体的名字应象:
        TCustomerEntryForm = class(TForm);

5.1.2 窗体实例命名标准

窗体实例应是没有带前缀T的相应类的名字。例如,对应于前面窗体类型而言,其实例的名字应为:

     类型名称                   实例名称
   TAboutForm                AboutForm
   TMainForm                 MainForm
   TCustomerEntryForm      CustomerEntryForm

5.1.3 自动创建窗体

只有主窗体可以是自动创建的除非有其它更好的理由不这样做。所有其它的窗体必需从工程选项对话框中的自动创建列表中移走。查阅以下部分来获得更多的信息。

5.1.4 模式窗体实例化函数

所有的窗体单元都应包含一个窗体实例化函数,该函数用来创建、设置、模式地显示窗体,并释放窗体。该函数应返回窗体的模式结果。该函数要传递的参数应遵循本文档指定的“参数传递”标准。通过这种方式封装的函数性有助于代码的再利用和维护。

该窗体的变量要从单元中移走,并再窗体实例的函数中进行本地式地定义。注意,这就意味着该窗体必需从工程/选项对话框中的自动创建列表中剔除。参考本文档后面的“自动创建窗体”。

例如,下面的单元展示了再GetUserData窗体中的一个函数。
  unit UserDataFrm;
  interface
  uses
windows, Messages, SysUtils, Classes, Graphics, Controls, Forms,
Dialogs, StdCtrls;
  type
    TUserDataForm = class(TForm)
      edtUserName : TEdit;
      edtUserID : TEdit;
    private
      { Private declarations }
    public
      { Public declarations }
    end;
  function GetUserData(var aUserName : String; var aUserID : Integer) :
    Word;
  implementation
  {$R *.DFM }

  function GetUserData(var aUserName : String; var aUserID : Integer) :
    word;
  var
    UserDataForm : TuserDataForm;
  begin
    UserDataForm := TuserDataForm.Create(Application);
    try
      UserDataForm.Caption := ‘Getting User Data’;
      Result := UserDataForm.ShowModal;
      if (Result = mrOK) then
 

上一页  [1] [2] [3] [4]  下一页


[Delphi程序]Delphi 程序员代码编写标准指南  [Delphi程序]Delphi 程序员代码编写标准指南 (五)
[Delphi程序]Delphi 程序员代码编写标准指南 (四)  [Delphi程序]Delphi 程序员代码编写标准指南 (三)
[Delphi程序]Delphi 程序员代码编写标准指南 (二)  [Delphi程序]Delphi  程序员代码编写标准指南
[Delphi程序]Delphi 程序员代码编写标准指南 (六)  [Delphi程序]蛙蛙推荐:Delphi 6 程序员代码编写标准指南
教程录入:mintao    责任编辑:mintao 
  • 上一篇教程:

  • 下一篇教程:
  • 【字体: 】【发表评论】【加入收藏】【告诉好友】【打印此文】【关闭窗口
      注:本站部分文章源于互联网,版权归原作者所有!如有侵权,请原作者与本站联系,本站将立即删除! 本站文章除特别注明外均可转载,但需注明出处! [MinTao学以致用网]
      网友评论:(只显示最新10条。评论内容只代表网友观点,与本站立场无关!)

    同类栏目
    · C语言系列  · VB.NET程序
    · JAVA开发  · Delphi程序
    · 脚本语言
    更多内容
    热门推荐 更多内容
  • 没有教程
  • 赞助链接
    更多内容
    闵涛博文 更多关于武汉SEO的内容
    500 - 内部服务器错误。

    500 - 内部服务器错误。

    您查找的资源存在问题,因而无法显示。

    | 设为首页 |加入收藏 | 联系站长 | 友情链接 | 版权申明 | 广告服务
    MinTao学以致用网

    Copyright @ 2007-2012 敏韬网(敏而好学,文韬武略--MinTao.Net)(学习笔记) Inc All Rights Reserved.
    闵涛 投放广告、内容合作请Q我! E_mail:admin@mintao.net(欢迎提供学习资源)

    站长:MinTao ICP备案号:鄂ICP备11006601号-18

    闵涛站盟:医药大全-武穴网A打造BCD……
    咸宁网络警察报警平台