本文主要基于“delphi development guide”一书的代码标准部分而来,编者参考其它的delphi代码标准规范,以及结合现目前delphi社区中流行的程序书写惯例,作了一些修改与裁剪,你也可以根据自己的需要进行裁剪与修改.如果你有什么建议,或是希望编者加上你认为遗漏的东西,欢迎email至:riceball@cq118.com
目录:
前言 程序书写规范">源程序书写规范 通用源代码书写规范 object pascal语句书写规范与用法 命名规范 过程(procedure)与函数(function) 变量(variable) 类型(type) 一般类型 构造类型 类类型(class) 字段 方法 属性 元件类型 窗体与对话框类型 数据模块类型 文件">文件 文件">项目文件(.dpr) 文件">窗体文件(.dfm) 文件">数据模块文件 文件">远程数据模块文件 文件">单元文件(.pas) 普通单元 窗体单元 通用单元 元件单元 文件(.dpk)命名规则">包文件(.dpk) 程序文档注释规范">源程序文档注释规范 注释文档的一般规范 文件注释文档格式">单元文件注释文档格式 函数(属性)的注释文档格式 delphi代码自动格式化工具 代码标准文档更新 附录:参考文献
1.前言
本文档主要是为delphi开发人员提供一个源代码书写标准,以及程序与文件的命名标准,使他们在编程时有一致格式可遵循.这样,每个编程人员编写的代码能够被其他人理解.
本文档还没能包括代码标准的每个细节,因此你可以在下面网址留意本文档的最新版本: http://dev.cq118.com/web/本文档不包含用户界面标准.用户界面标准是独立于其他标准的,并且同样是重要的.
如果你有什么建议,或是希望编者加上你认为遗漏的东西,欢迎email至:riceball@cq118.com
2.程序书写规范">源程序书写规范
2.1.通用源代码格式规则
1). 缩进
缩进就是每级间有两个空格.不要在源代码中放置制表符.这是因为,制表符的宽度随着不同的设置与代码管理实用程序(打印.文档及版本控制等)而不同.
通过使用tools|environment 菜单,在environment options 对话框的general页上,不要选中use tab character 与optional fill 复选框,这样,制表符就不会被保存.
2). 边距
边距设置为80个字符.源代码一般不会因写一个单词而超过边距,但本规则比较灵活.只要可能,长度超过一行的语句应当用逗号或运算符换行.换行后,应缩进两个字符.
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 2.0以下的版本,可以使用“//”注释.
2.2.object 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
... 下一页