delphi 程序设计编程规范.doc

编号:YUNTONG-TECH-01
版本:
YUNTONG-TECH
程序设计规范
(Delphi)
北京运通恒远数控技术有限公司
2002年01月25日
文档修改状态
日期
版本
修改内容
作者
审核
质保
批准

1
初始版本
王凯

2
修改程序规范坚检查清单
王凯

2
1、修改单位的定义,与Delphi一致。
2、把RelTest采用的规范融合进来。
江建斌
目录
1 概述 1
编写目的 1
参考资料 1
2 程序文件 1
项目文件的组织 1
常量定义 2
结构类型定义 2
3 程序风格 3
函数(Function)/过程(Procedure)风格 3
语句风格 3
变量定义语句 3
赋值语句 3
条件语句 3
循环语句 4
开关语句 4
注释行 4
4 变量名命名规则 5
简单变量命名 5
结构型变量命名 6
复合变量命名 6
命名中限制的法则 6
其它命名 7
文件及窗体命名 7
控件命名 7
Standard 页控件 7
Additional 页控件 8
Win32 页控件 8
System 页控件 8
页控件 9
Data Access 页控件 9
Data Controls 页控件 9
Midas 页控件 10
Decision Cube 页控件 10
QReport 页控件 10
Dialogs 页控件 11
Win 页控件 11
Samples 页控件 11
ActiveX 页控件 12
常用类的命名 12
5 应用程序的界面设计 13
概述 13
目的 13
目标 13
菜单设计 13
菜单类型 13
菜单的设计规范 14
窗体/对话框设计 15
一般说明 15
消息对话框 15
窗体 16
6 防错误处理 20
7 框架和各个工具的接口 21
接口方式 21
接口要求 21
概述 21
实现 21
可预知的限制 21
8 版本号格式 21
9 检查单 21
10 补充 23
概述
编写目的
本规范规定了YUNTONG-TECH程序在编写过程中涉及到的程序文件和编码风格。本规范以 Delphi 语言为标准制定,使用其它编程语言的编码风格和规范在相关的文档中规定。
参考资料
程序员指南,Microsoft Press
Windows界面应用程序设计指南,Microsoft Press
Delphi 5 开发人员指南,机械工业出版社
程序设计规范VB,聂俊华,北航十四系
程序文件
项目文件的组织
在Delphi中,按照项目为单位来组织程序文件。在一个典型的项目中包括:
项目文件(.DRP文件)
含有工程主程序的Pascal源代码;
单元文件(.PAS文件)
项目中每个窗体的Pascal源文件,包含该窗体的所有声明和过程(包括时间处理过程);
窗体文件(.DFM文件)
含有一个窗体的设计属性的二进制文件,;
资源文件(.RES文件)
编译的二进制资源文件,被链接到应用程序的可执行文件中;
项目选项文件(.DOF文件)
存储了Project|Options菜单命令所设置的项目选项;
桌面设置文件(.DSK文件)
存储了Tools|Options菜单命令所设置的桌面选项;
包文件(.DPK/.BPL文件)
用于共享组件、类、数据和代码的文件。,;
每个软件项目应使用独立的目录,软件项目下的不同类别文件、不同模块分设子目录。
以下给出软件项目及软件模块中,设置子目录名称的规范:
子目录
说明
\Bin
建立产品的工作目录,存放项目中所有可执行文件的当前版本。
\Lib
与项目有关的库文件。
\Man
包括项目的所有外部文档。包括手册、帮助文件、其他在线文档、README文件