Delphi程序员代码编写标准指南【DOC精选】.docVIP

Delphi 程序员代码编写标准指南 一、序言 本文档详述了在Delphi 开发者指南下进行编程的代码编写标准。在通常情况下，本文档遵循“取消”式格式的指引方针，该方针由Borland国际通过一些例外来使用。在Delphi 开发者指南中包含本文档的目的在于阐述一种方法，通过该方法，开发小组可以在他们所编写的代码中保持一贯的风格。这样做的目的是使在开发小组中的每一个程序员都可以明白其他程序员的代码。这有助于提高代码编写的可读性和使用的一贯性。 本文档并不意味着包含了所有存在于代码中的标准。但是，它的内容已足够帮你起个好头。你可以自由的增加修改这些标准来满足你的需要。我们不赞成你偏离这些由Borland开发人员所使用的标准太远。我们推荐这么做是因为一旦有新的程序员加入到你的开发小组中，而他们最喜欢和最熟悉的是Borland的标准。象大多数代码标准文档，本文档也会根据需要进行改动。因此，你可以到/ddg中找到最新的更新版本。本文档不包括用户接口标准。本文档是独立的但也是同样重要的。已经有足够的第三方书籍和Microsoft文档包括了另外一些指导方针，而我们决定并不复制这些信息，但我们会指引你到Microsoft Developers Network 和一些资源，在那儿可以找到你所需的信息。 二、通用源代码格式规则 2.1 缩格 缩格是指在每一级有两个空格。不要在源代码中保留tab字符，这是因为tab字符会随着不同用户的不同设置和不同的资源管理工具（打印、文档、版本控制等）而代表不同的宽度。 你可以通过关闭Environment选项对话框中Editor页上的“Use tab character”和“Optimal fill”检查框（通过Tools|Environment）来禁止保存tab字符。 2.2 页边空格 页边空格会被设置成80字符宽。通常，源码不会超出这个边界，但这个方针会有一些弹性。不管是否有可能，那些超出到另一行的语句会在一个逗号或其他操作符之后与前面的语句相连。当一个语句被打断相连时，它应比原来的那一行语句缩进两个字符。 2.3 Begin...End 配对 Begin 子句应写在独立的一行。例如，下面第一行是错误的写法而第二行是正确的。 for I := 0 to 10 do begin //错误，begin同for在同一行 for I := 0 to 10 do //正确，begin出现在独立的一行 begin 这个规则的例外是当begin子句的出现是作为一个else子句的一部分－参考例子： if some statement then begin ... end else begin someOtherStatement; end; end 语句永远出现在独立的一行。 当begin语句不是一个else子句的一部分时，相应的end语句永远缩进到与begin部分相对应的位置。 三、Object Pascal 3.1 括号 永远不要在括号与括号之间的字符中间留下空格。下面的例子示范了错误的与正确地使用括号中的空格： CallProc( Aparameter ); //错误 CallProc(Aparameter); //正确 永远不要在一个语句中使用不必要的括号。括号只应在源代码中需要的地方使用。以下的例子示范了错误和正确的使用： if (I = 42) then //错误 － 多余的括号 if (I = 42) or (J = 42) then //正确 － 需要括号 3.2 保留字和关键字 Object Pascal 保留字和关键字永远是全部小写。 3.3 过程和函数（例程） 3.3.1 命名/格式化 例程的名字永远应该以大写的字母开头并且中间错落分明以便于可读性。下面是一个不正确格式的过程名称： procedure thisisapoorlyformattedroutinename; 下面是一个合适的大小写例程名称的例子： procedure ThisIsMuchMoreReadableRoutineName; 例程的名称应该同它的内容相符。一个会导致某个行为的例程应以动词开头。例如： procedure FormatHardDrive; 一个用于设置输入参数的例程应以单词set作为前缀，例如： procedure SetUserName; 一个用来接收某个值的例程应以单词get作为前缀，例如： p