Delphi代码的标准风格

Delphi代码的标准风格ObjectPascalStyleGuide-ByCharlesCalvert(对象Pascal编码风格向导-译：TommyTong)我们承认许多好的已经确定的工作室或个人，拥有他们自己的和本文里所说的不同的编程习惯，但是，我们强烈建议你使用一个工具将你的代码转换为Borland风格的代码，然后再提交给Borland，ProjectJEDI或其他任何公开的源代码知识库。我们不想强迫你改变你的习惯，但我们坚持所有同Borland产品一起工作的的代码遵循本文描述的习惯。对象Pascal是一种优美的设计语言。较强的可读性就是它的一个优点。本文设计的标准将增强对象Pascal代码的可读性。当开发人员遵从本文展现的这些简单的习惯，他们也将成为标准，这将有益于所有的Delphi开发人员使用统一的易读的代码风格。执行这些标准的努力将增加开发人员的源代码的价值，特别是在维护和调试循环阶段。尽管我们相信并且赞美本文所宣扬的风格，但我们没有必要支持它，因为它本身是正确的而其它的则是错误的。然而我们相信绝大多数开发人员遵从的标准是有它的功效的，所以我们仍然支持并维护该风格。人类的大脑总在适应标准，并且找寻方法去快速组织所熟悉的模式，从而快速而有效地理解其含义。正是因这种要求而建立的标准将使大量的人尽可能容易的阅读代码。如果在初次使用我们的指导方针是感到陌生，那么我们请你坚持一会儿，你会发现你也变得习惯了。或者，如果你愿意，你也可以保持你自己的风格，并通过一个遵从我们标准的程序来转换，然后你可以将你的代码提交给Borland或其他知识库了。一些文本编辑器，象VisualSlickEdit可以帮助你按照一定的风格来格式化你的代码。一个免费的由EgbertvanNes开发的格式化程序可以在以下的连接获得：另一个针对Delphi的商业化程序是CrackerJax：－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－1.0介绍本文不是为ObjectPascal语言定义语法规则的一种尝试。例如：在else前面放置封号；是违法的；编译器不允许这种用法。所以我不会在本文中展示语法规则。本文旨在在语言提供选择的地方定义适当的行为习惯。我通常在只有一种控制方法的地方保持沉默。1.1背景在本文出现的指导方针基于Delphi源代码的一部分。Delphi源代码恰好遵循这些指导方针。如果你发现了违反这些原则的情况，那么应该是这些原则而不是那些不确定的源代码成为你的指导方针。然而，你可以使用这些原代码作为这些原则的补充，至少它可以帮助你得到关于你自己的代码的形式的一般看法。1.2感谢本文这些格式是基于已完成的为Java语言定义的风格标准的工作的。Java在规则上对格式化ObjectPascal源代码是没有任何影响的，但在Sun网站上的文档是本文的基础。在某些特殊的地方本文的风格和格式受到ACodingStyleGuideforJavaWorkShopandJavaStudioProgramming(AchutReddy,《Java车间和Java工作室的编码向导》)的很大启发。该文章可在该URL找到：小组为本文的完成做出了重大贡献，事实上，如果没有它们的帮助，本文是无法完成的。2.0源文件ObjectPascal源代码主要被分成单源文件和项目文件，他们都遵从相同的习惯。Delphi项目文件有一个.DPR的扩展名。它是项目的主文件。任何在项目中使用的单元文件都有一个.PAS的扩展名。其它的文件，象批处理文件、HTML文件或者DLLs也可以在项目中扮演一个角色，但本文只涉及项目文件和单元文件。2.1源文件命名ObjectPascal支持长文件名。如果你使用几个单词来形成一个单一的名称，那么最好是为每个单词使用大写的开头字母：MyFile.pas。这被认为是插入式大写或驼峰式大写。扩展名应当使用小写形式。由于历史原因，Delphi源代码经常使用8:3式命名模式，但开发人员不必为上述规则所限制而转向Delphi小组的用法。如果你正在翻译一个C/C++头文件，那么你翻译的Pascal文件要与C/C++头文件保持相同的主文件名，扩展名用.PAS。例如：Windows.h-Windows.pas。如果Pascal语法强迫你将几个头文件组合到一个单一的单元文件中，那么包含其他头文件的那个头文件的文件名将作为新单元文件的名称。例如：Windows.h包含了WinBase.h文件，则新的单元文件名为Windows.pas.2.2源文件组织所有的ObjectPascal单元文件应当按照以下的顺序包含下列元素：版权／标识块注释单元名接口段实现部分一个结束符end.每个部分之间至少空一行。其它的元素应当被结构化成你认为最适当的顺序。但版权应当出现在文件的最开始，然后是单元名，然后是任何条件定义、编译器指示符或包含语句，然后是uses字句：{*******************************************************}{}{BorlandDelphiVisualComponentLibrary}{}{Copyright(c)1995,98InpriseCorporation}{}{*******************************************************}unitButtons;{$S-,W-,R-}{$CPRELOAD}interfaceusesWindows,Messages,Classes,Controls,Forms,Graphics,StdCtrls,ExtCtrls,CommCtrl;如果你将type段放到const段之前，或者将它们两者混合，那是没有什么影响的。实现部分需要首先将implementation写出来，然后是uses字句，然后是其它的包含声明或别的指示符：implementationusesConsts,SysUtils,ActnList,ImgList;{$RBUTTONS.RES}2.2.1版权／标识块注释每一个源文件都应当以一个包含版本信息和标准版权布告块注释开始。版本信息可以象下面这样：{*******************************************************}{}{WidgetsGalore}{}{Copyright(c)1995,98YourCompany}{}{*******************************************************}版权布告至少需要包含以下行：版权所有(C)年份版权所有者如果你是为Borland开发软件的第三方，你可以在版权的最后加入你自己的名字：{*******************************************************}{}{BorlandDelphiVisualComponentLibrary}{Copyright(c)1995,99BorlandInternational}{CreatedbyProjectJEDI}{}{*******************************************************}2.2.2unit声明每一个单元文件要有一个unit声明。unit是一个保留字，因此它需要小写。单元的名称可以是大小写混合的，但必须和单元文件的文件名相同。例如：unitMyUnit;则单元文件的名称应当为MyUnit.pas。在文件系统中，它作为这个文件的入口。2.2.3uses声明在单元内部，uses声明应当使用小些的uses引导。被引用的单元名要遵循在他自己的单元中被定义时使用的大写习惯：usesMyUnit;每一个单元名被一个逗号同其相邻的单元名分开，最后一个单元名后面跟一个分号：usesWindows,SysUtils,Classes,Graphics,Controls,Forms,TypInfo;在uses的下一行开始加入单元名和在uses后面直接加入单元名同样都是正确的。usesWindows,SysUtils,Classes,Graphics,Controls,Forms,TypInfo;你可以格式化你的单元名列表，可以在80个字符限制下换行，或者每个单元名一行。2.2.4类和接口定义类的定义以两个空格开始，然后是一个前缀T。前缀要大写，每个内嵌的单词要大写开头。不要在ObjectPascal源代码中使用制表符Tab。例：TMyClass在标识符之后接一个空格，然后是等号，然后是class单词，class要小写：TMyClass=class如果你的类是从祖先继承来的，则需要加入包含着祖先类的左右括号：TMyClass=class(TObject)范围指示符离页边两个空格，并以下面的顺序出现：TMyClass=clss(TObject)privateprotectpublicpublishedend;数据通常只在private段声明，并且它们的标识符以F开始。所有此类的声明离页边4个空格：TMyClass=class(TObject)privateFMyDate:Integer;functionGetDate:Integer;procedureSetData(Value:Integer);publicpublishedpropertyMyData:IntegerreadGetDatawriteSetData;end;接口遵从同类相同的规则，除了你应当忽略范围指示符和私有数据，并且使用interface单词代替class单词。命名习惯除了保留字和指示符是小写外，所有的Pascal标识符应当使用驼峰式格式，即每个标识符开头字母要大写，内嵌单词的首字母也要大写，只取首字母的缩写词也一样。MyIdentifierMyFTPClass对此规则主要的例外是头文件翻译的情况，应当遵循在原头文件中的命名习惯。例如：WM_LBUTTONDOWN，不要写成wm_LButtonDown.除了头文件翻译外，不要使用下划线分割单词。类名应当是名词或名词短语。接口或类的名称依赖于接口的显而易见的目的、用途。好的名字：AddressForm,ArrayIndexOutOfBoundsException低劣的名字：ManageLayout//使用动词短语delphi_is_new_to_me//使用下划线3.1单元命名参见单元声明3.2类／接口命名参见类／接口声明3.3域／字段命名使用驼峰式格式。以大写的F开始，并且在private中声明所有的数据，使用属性或获取者(getter)和安装者(setter)来提供公共的存取操作。例如：使用名字GetSomething来命名一个返回内部域／字段值的函数，使用SetSomething来命名一个设置域／字段值的过程。不要在const段全部使用大写，除非是头文件翻译的需要。Delphi是在加利福尼亚开发的，所有我们阻止记号的使用，除非是头文件翻译的需要。正确：FMyString:string;不正确：lpstrMyString:string;当然在枚举类型定义中保留了匈牙利命名法：TBitBtnKind=(bkCustom,bkOK,bkCancel,bkHelp,bkYes,bkNo,bkClose,bkAbort,bkRetry,bkignore,bkAll);在这种情况下字符bk被插入到这个枚举类型的每一个元素前。bk意味着ButtonKind。在考虑命名习惯时，要避免使用单个字符的名称，但零时变量和循环变量除外。避免使用l(L)变量，因为它和1(one)无论在打印