Delphi编码注释规范.docVIP

北京新网医讯技术有限公司 Delphi程序编码及注释规范 V1.0 2011/3/14 目 录 Delphi程序员代码编写标准 - 1 - 一、序言 - 1 - 二、通用源代码格式规则 - 1 - 2.1 缩格 - 1 - 2.2 页边空格 - 1 - 2.3 Begin…End 配对 - 2 - 三、Object Pascal - 2 - 3.1 括号 - 2 - 3.2 保留字和关键字 - 3 - 3.3 过程和函数（例程） - 3 - 3.3.1 命名/格式化 - 3 - 3.3.2 形式参数 - 3 - 3.4 变量 - 5 - 3.4.1 变量的命名和格式 - 5 - 3.4.2 局部变量 - 5 - 3.4.3 全局变量的使用 - 5 - 3.5 类型 - 5 - 3.5.1 大写约定 - 5 - 3.5.2 结构类型 - 6 - 3.6 语句 - 7 - 3.6.1 if 语句 - 7 - 3.6.2 case 语句 - 8 - 3.6.3 while 语句 - 8 - 3.6.4 for 语句 - 8 - 3.6.5 repeat 语句 - 8 - 3.6.6 with 语句 - 8 - 3.7 结构异常处理 - 9 - 3.7.1 一般话题 - 9 - 3.7.2 try…finally的使用 - 9 - 3.7.3 try…except的使用 - 10 - 3.7.4 try…except…else的使用 - 10 - 3.8 类类型 - 10 - 3.8.1 命名和格式 - 10 - 3.8.2 域 - 11 - 3.8.4 属性 - 12 - 四、文件 - 12 - 4.1 工程文件 - 12 - 4.1.1 命名 - 12 - 4.2 窗体文件 - 12 - 4.2.1 命名 - 12 - 4.3 数据模板文件 - 13 - 4.3.1 命名 - 13 - 4.4 远端数据模板文件 - 13 - 4.4.1 命名 - 13 - 4.5 Unit文件 - 13 - 4.5.1 通用Unit结构 - 13 - 4.5.3 数据模板单元 - 14 - 4.5.4 一般目的单元 - 14 - 4.5.5 构件单元 - 14 - 4.6 文件头 - 15 - 五、窗体和数据模板 - 15 - 5.1 窗体 - 15 - 5.1.1 窗体类型命名标准 - 15 - 5.1.2 窗体实例命名标准 - 15 - 5.1.3 自动创建窗体 - 16 - 5.1.4 模式窗体实例化函数 - 16 - 5.2 数据模板 - 18 - 5.2.1 数据模板命名标准 - 18 - 5.2.2 数据模板实例命名标准 - 18 - 六、包 - 18 - 6.1 使用运行包和设计包的比较 - 18 - 6.2 文件命名标准 - 18 - 七、构件 - 19 - 7.1 用户自定义构件 - 19 - 7.2 构件单元 - 19 - 7.3 使用注册单元 - 19 - 7.4 构件实例命名约定 - 20 - 7.5 构件的前缀 - 20 - 7.6 Standard页 - 20 - 7.7 Additional页 - 21 - 7.8 Win32页 - 22 - 7.9 System页 - 22 - 7.10 Internet页 - 23 - 7.11 Data Access页 - 24 - 7.12 Data Controls页 - 24 - 7.13 Decision Cube页 - 25 - 7.14 QReport页 - 25 - 7.15 Dialogs页 - 26 - 7.16 Win3.1页 - 27 - 7.17 Samples页 - 27 - 7.18 ActiveX页 - 28 - 7.19 Midas页 - 28 - 8．注释规范 - 28 - 8．1修改历史记录 - 29 - 8．2新增代码行 - 29 - 8．3删除代码行 - 29 - 8．4修改代码行 - 29 -  Delphi编码及注释规范 一、序言 本文档详述了在Delphi下进行编程的代码编写标准。在通常情况下，本文档遵循“取消”式格式的指引方针，该方针由Borland国际通过一些例外来使用。在Delphi 开发者指南中包含本文档的目的在于阐述一种方法，通过该方法，开发小组可以在他们所编写的代码中保持一贯的风格。这样做的目的是使在开发小组中的每一个程序员都可以明白其他程序员的代码。这有助于提高代码编写的可读性和使用的一贯性。 本文档并不意味着包含了所有存在于代码中的标准。但是，它的内容已足够帮你起个好头。你可以自由的增加修改这些标准来满足你的需要。我们不赞成你偏离这些由Borland开发人员所使用的标准太远。我们推荐