代码编写指导规范_1.doc

SQL代码编写指导规范 PAGE 第 PAGE 1 页 共 NUMPAGES 9 页 SQL代码编写指导规范 项目： 规范 文号： COD-STA-03 版本： V1.1 编写者： 许飞云 时间： 2005- SQL代码编写指导规范 版本变更说明： 时间 版本 作者/修改人 变更原因 2005-11-4 V1.0 许飞云 初版发布 2007-3-5 V1.1 刘莉 添加 HYPERLINK \l _5.4__约定规则 5.4 约定规则 目 录 TOC \o 1-3 \h \z \u HYPERLINK \l _Toc 1 简介 PAGEREF _Toc \h 2 HYPERLINK \l _Toc 1.1 目标 PAGEREF _Toc \h 2 HYPERLINK \l _Toc 1.2 范围 PAGEREF _Toc \h 2 HYPERLINK \l _Toc 1.3 基本依据 PAGEREF _Toc \h 2 HYPERLINK \l _Toc 1.4 使用约定 PAGEREF _Toc \h 2 HYPERLINK \l _Toc 1.4.1 规则 PAGEREF _Toc \h 2 HYPERLINK \l _Toc 1.4.2 建议 PAGEREF _Toc \h 2 HYPERLINK \l _Toc 1.5 术语和缩略语 PAGEREF _Toc \h 2 HYPERLINK \l _Toc 1.6 参考 PAGEREF _Toc \h 3 HYPERLINK \l _Toc 2 通用规则 PAGEREF _Toc \h 3 HYPERLINK \l _Toc 3 配置约定 PAGEREF _Toc \h 3 HYPERLINK \l _Toc 4 格式约定 PAGEREF _Toc \h 3 HYPERLINK \l _Toc 5 命名约定 PAGEREF _Toc \h 4 HYPERLINK \l _Toc 5.1 一般规则 PAGEREF _Toc \h 4 HYPERLINK \l _Toc 5.2 命名规则 PAGEREF _Toc \h 4 HYPERLINK \l _Toc 5.3 常用规则 PAGEREF _Toc \h 5 HYPERLINK \l _Toc 5.4 约定规则 PAGEREF _Toc \h 6 HYPERLINK \l _Toc 5.4.1 表名采用前缀+表名的方式，前缀定义如下: PAGEREF _Toc \h 6 HYPERLINK \l _Toc 6 注释 PAGEREF _Toc \h 7 HYPERLINK \l _Toc 6.1 SQL代码注释 PAGEREF _Toc \h 7 HYPERLINK \l _Toc 6.2 对象注释 PAGEREF _Toc \h 7 HYPERLINK \l _Toc 7 嵌入式代码 PAGEREF _Toc \h 8 1 简介 开发小组在进行 SQL 编程时常常会忽略所谓的编码标准，但这些标准却是开发小组顺利开展工作的关键工具。这里介绍的编码标准是经整理出来的开发成果。它们当然还没有得到普遍接受，而且不可否认，有些标准带有主观色彩。整理出此规范实际上更多的是为了提高大家的意识，而不是吹捧每个人是 SQL 编写方面的仲裁者：最重要的是要建立某些合理的编码标准并遵循这些标准。您在这篇文章中会发现有关 SQL 编程的一系列不同的编码标准、技巧和提示。它们并未以任何特定的优先级或重要性顺序列出。 1.1 目标 本主题提供SQL编程语言的命名指南。希望能对下述情况有积极的作用： 避免Errors/Bugs ，特别是难以查询的Errors/Bugs 规范不良的编码习惯 提高程序的可读性、可维护性和可移值性 1.2 范围 规范只针对 SQL Server数据库中的SQL编程语言。 1.3 基本依据 本文档主要依据一位具有超过 25 年经验的数据库管理员和应用程序开发员 Brian Walker 提出的开发成果。 同时也可参考MSDN文档中相应的规范。 1.4 使用约定 1.4.1 规则 本文档表明没有特别的理由必须要遵守的要求。违反规则的编码人员必须至少同有经验的同事商量并取得违反规则的理由共识后才能实施。必须对违反规则的代码进行注解。 1.4.2 建议 正常情况下优先考虑