程序设计规范(Delphi)
1. 概述:
1.1. 编写目的
本规范规定了YUNTONG-TECH程序在编写过程中涉及到的程序文件和编码风格。
本规范以 Delphi 语言为标准制定,使用其它编程语言的编码风格和规范在相关的文档中规定。
1.2. 参考资料
(1)程序员指南,Microsoft Press
(2)Windows界面应用程序设计指南,Microsoft Press (3)Delphi 5 开发人员指南,机械工业出版社 (4)程序设计规范VB,聂俊华,北航十四系
2. 程序文件
1.1. 项目文件的组织
在Delphi中,按照项目为单位来组织程序文件。在一个典型的项目中包括: (1)项目文件(.DRP文件)含有工程主程序的Pascal源代码;
(2)单元文件(.PAS文件)项目中每个窗体的Pascal源文件,包含该窗体的所有声明和过程(包括时间处理过程);
(3)窗体文件(.DFM文件)含有一个窗体的设计属性的二进制文件,每个窗体的.DFM文件与.PAS文件相互对应;
(4)资源文件(.RES文件)编译的二进制资源文件,被链接到应用程序的可执行文件中; (5)项目选项文件(.DOF文件)存储了Project|Options菜单命令所设置的项目选项; (6)桌面设置文件(.DSK文件)存储了Tools|Options菜单命令所设置的桌面选项;
(7)包文件(.DPK/.BPL文件)用于共享组件、类、数据和代码的文件。源文件为.DPK文件,编译后为.BPL文件;每个软件项目应使用独立的目录,软件项目下的不同类别文件、不同模块分设子目录。
以下给出软件项目及软件模块中,设置子目录名称的规范: 子目录 说明
\\Bin 建立产品的工作目录,存放项目中所有可执行文件的当前版本。 \\Lib 与项目有关的库文件。
\\Man 包括项目的所有外部文档。包括手册、帮助文件、其他在线文档、README文件以
及其他将和产品一起发放到用户手中的文档。
\\SQL 存放数据库的SQL文件(只针对数据库程序的开发) 。
\\Res 包括应用程序的所有共享资源,如ICON(图表)、资源文件、Bitmap等。 \\Include 公用的窗体或Unit。
\\Control 存放项目内用的自编或第三方提供的控件。 \\Source 程序源代码\\Public 可以公用的模块或程序。
本规范在以下的各小节中具体说明Delphi 两种文件类型.PAS和.DFM在程序文件中的相关内容要求。
1.2. 常量定义
内容:
l 逻辑值的定义; l 常数值的定义; l 错误码的定义;
格式:一个定义占一行。如下: Const <常量> : 类型 = 值; //注释 说明:
使用 Const 语句来声明用于代替文字值的常数。
示例:Const C_SQL:string='select CH_USERER_ID from T_CD_USER'; //查询用户ID Const C_PI:real =3.1415926; //圆周率
1.3. 结构类型定义
内容:结构类型定义 格式: Type
<类型名> //结构说明注释
<变量名1> : 变量类型; //变量说明注释 <变量名2> : 变量类型; //变量说明注释 … End ;
说明:
<类型名>是以大写字母开头的字符串。结构定义中定义变量类型的语句从第二行第五列开始。 示例: type
TableList=record //系统树单元类型定义 InID : integer; //单元编号 Name : string; //单元名称
PID : string; //上一级单元名称
PT : PTableList; //指向下一单元类型的指针
end;
3. 程序风格
程序风格规定了每个语句的定位规则及程序中的注释。
1.1. 函数(Function)/过程(Procedure)风格
Name (变量 :变量类型[,…]); //函数/过程说明 Var
变量1:变量类型;//变量说明 变量2:变量类型;//变量说明 … Begin 语句; 语句; … End ;
注: 变量声明、语句均从第三列写起,如有缩进,每次缩进两列,并与相对应语句对齐。
1.2. 语句风格
说明:
l 在程序体中通常最多每十行有一个段落功能说明; l 规范使用各种语句;
l 语句中有缩进是以二列为单位。
1.2.1. 变量定义语句
Var
var_name : <数据类型>;
1.2.2. 赋值语句
var_name: = <表达式>;
1.2.3. 条件语句
If 条件 Then //注释