Delphi代码标准文档.doc

文档介绍：Delphi代码标准文档
SMP
本文主要基于“Delphi Development Guide”一书的代码标准部分而来,编者参考其它的Delphi代码标准规范,以及结合现目前Delphi社区中流行的程序书写惯例,作了一些修改和裁剪。

本文档主要是为Delphi开发人员提供一个源代码书写标准,以及程序和文件的命名标准,使他们在编程时有一致格式可遵循。这样,每个编程人员编写的代码能够被其他人理解。
本文档不包含用户界面标准。用户界面标准是独立于其他标准的,并且同样是重要的。


1). 缩进
缩进就是每级间有两个空格。不要在源代码中放置制表符。这是因为,制表符的宽度随着不同的设置和代码管理实用程序(打印、文档及版本控制等)而不同。
通过使用Tools|Environment 菜单,在Environment Options 对话框的General页上,不要选中Use Tab Character 和Optional Fill 复选框,这样,制表符就不会被保存。
2). 换行
长度超过一行的语句应当用逗号或运算符换行。换行后,应缩进两个字符。
3). begin...end 语句
begin 语句必须单独占一行。例如,下面第一行是错误的,而第二行正确:
for i:=0 to 10 do begin // 错, begin 与f o r 在同一行
for i:=0 to 10 do // 对, begin 在另外一行中
begin
本规则的一个特殊情况是,当begin 为else 语句的一部分时,例如:
if some statement = then
begin
. . .
End
else
begin
Some Other Statement;
end;
注意:end 语句总单独一行。当begin 不为else 语句的一部分时,相应的end 语句与begin 语句的缩进量相同。
4).注释
我们通常使用“{...}”类型的块注释,以前的“(*...*)”类型的块注释用于临时注释掉暂不使用的代码,从Delphi 2开始支持“//”行注释,如果决定不在支持Delphi ,可以使用“//”注释。
Pascal语句格式语句书写规范与用法
1). 括号
在左括号与下一字符之间没有空格。同样,右括号与前一字符也没有空格。下面的例子演示了正确与不正确的空格。
CallProc( Aparameter ); // 错!
CallProc(Aparameter); // 正确!
不要在语句中包含多余的括号。在源代码中,括号只有在确实需要时才使用。下面的例子演示了正确与不正确用法:
if (I=42) then // 错,括号是多余的
if (I=42) or (J=42) then // 正确,必须使用括号
2). 保留字和关键字
Object Pascal 语言的保留字和关键字总是完全的小写。下面是Delphi 5保留字列表:
and
array
as
asm
begin
case
class
const
constructor
destructor
dispinterface
div
do
downto
else
end
except
exports
file
finalization
finally
for
function
goto
if
implementation
in
inherited
initialization
inline
interface
is
label
library
mod
nil
not
object
of
or
out
packed
procedure
program
property
raise
record
repeat
resourcestring
set
shl
shr
string
then
threadvar
to
try
type
unit
until
uses
var
while
with
xor
private
protected
public
published
automated



3). 过程和函数
(1). 格式
过程名应当以大写字母开始,且大小写交错以增加可读性。下面是一个不正确的写法: procedure thisisapoorlyformattedroutinename;
改成这样写就对了:procedure ThisIsMuchMoreR