Delphi 6 程序员代码编写标准指南
一、序言 二、通用源代码格式规则
2.1 缩格 2.2 页边空格 2.3 Begin…End 配对 2.4 代码文件中通用符号含义
三、Object Pascal
3.1 括号 3.2 保留字和关键字 3.3 过程和函数(例程) 3.3.1 命名/格式化 3.3.2 形式参数
3.3.2.1 3.3.2.2 3.3.2.3 3.3.2.4 3.3.2.5 格式化 命名 参数的排序 常量参数 名称的冲突
3.4 变量 3.4.1 3.4.2 3.4.3 3.5 类型 3.5.1
变量的命名和格式 局部变量 全局变量的使用 大写约定
3.5.1.1 浮点指针类型 3.5.1.2 枚举类型 3.5.1.3 变数和 ole 变数类型
3.5.2 结构类型
3.5.2.1 数组类型 3.5.2.2 记录类型
3.6 语句 3.6.1 if 语句 3.6.2 case 语句
3.6.2.1 一般性话题 3.6.2.2 格式
3.6.3 while 语句 3.6.4 for 语句 3.6.5 repeat 语句
第 1 页 共 27页
3.6.6 with
语句
3.6.6.1 一般话题 3.6.6.2 格式
3.7 结构异常处理 3.7.1 一般话题 3.7.2 try…finally 的使用 3.7.3 try…except 的使用 3.7.4 try…except…else 的使用 3.8 类类型 3.8.1 命名和格式 3.8.2 域
3.8.2.1 命名/格式 3.8.2.2 可视化
3.8.3 方法
3.8.3.1 3.8.3.2 3.8.3.3 3.8.3.4 3.8.3.5 命名/格式 使用静态的方法 使用虚拟/动态的方法 使用抽象的方法 属性存取方法
3.8.4 属性
3.8.4.1 命名/格式 3.8.4.2 使用存取的方法
四、文件
4.1 工程文件 4.1.1 命名 4.2 窗体文件 4.2.1 命名 4.3 数据模板文件 4.3.1 命名 4.4 远端数据模板文件 4.4.1 命名 4.5 Unit 文件 4.5.1 通用 Unit 结构
4.5.1.1 4.5.1.2 4.5.1.3 4.5.1.4 4.5.1.5 4.5.1.6 unit 的名字 uses 子句 interface 部分 implementation 部分 initialization 部分 finalization 部分
4.5.2 窗体单元
第 2 页 共 27页
4.5.2.1 命名
4.5.3 数据模板单元
4.5.3.1 命名
4.5.4 一般目的单元
4.5.4.1 命名
4.5.5 构件单元
4.5.5.1 命名
4.6 文件头 五、窗体和数据模板 5.1 窗体 5.1.1 窗体类型命名标准 5.1.2 窗体实例命名标准 5.1.3 自动创建窗体 5.1.4 模式窗体实例化函数 5.2 数据模板 5.2.1 数据模板命名标准 5.2.2 数据模板实例命名标准 六、包 6.1 使用运行包和
设计包的比较 6.2 文件命名标准 七、构件 7.1 用户自定义构件 7.2 构件单元 7.3 使用注册单元 7.4 构件实例命名约定 7.5 构件的前缀 7.6 Standard 页 7.7 Additional 页 7.8 Win32 页 7.9 System 页 7.10 Internet 页 7.11 Data Access 页 7.12 Data Controls 页 7.13 Decision Cube 页 7.14 Qreport 页 7.15 Dialogs 页 7.16 Win3.1 页 7.17 Samples 页 7.18 ActiveX 页 7.19 Midas 页 7.20 ADO 页 7.21 InterBase 页 7.22 InternetExpress 页 7.23 FastNet 页
第 3 页 共 27页
一、序言
本文档详述了使用
Delphi 5 进行编程的代码编写标准。本文档的目的在于阐述一种方法, 通过该方法, 开发小组可以在他们所编写的代码中保持一贯的风格。 这样做的目的是使在开 发小组中的每一个程序员都可以明白其他
程序员的
代码。 这有助于提高代码编写的可读性和 使用的一贯性。 本文档并不意味着包含了所有存在于代码中的标准。但是,它的内容已足够帮你起个好头。 你可以自由的增加修改这些标准来满足你的需要。我们不赞成你偏离这些由 Borland 开发人 员所使用的标准太远。 我们推荐这么做是因为一旦有新的程序员加入到你的开发小组中, 而 他们最喜欢和最熟悉的是 Borland 的标准。象大多数代码标准文档,本
文档也会根据需要 进行改动。本
文档不包括用户接口标准。本文档是独立的但也是同样重要的。本文档由杨千 栋改编和维护,如果你有好的建议请联系 user22@laneasy
二、通用源代码格式规则 2.1 缩格
缩格是指在每一级有两个空格。不要在
源代码中保留 tab 字符,这是因为 tab 字符会随着 不同用户的不同设置和不同的资源管理工具 (打印、 文档、 版本控制等) 而代表不同的宽度。 你可以通过关闭 Environment 选项对话框中 Editor 页上的“Use tab character” 和“Optimal fill”检查框(通过 Tools|Environment)来禁止保存 tab 字