ETL 脚本书写规范

2014/11/24

1.  前言

为了统一软件开发过程中关于SQL(Structured Query Language)编码的格式，使编码人员编写SQL代码遵从特定的风格，并养成良好的开发习惯，从而增强代码的可读性，便于交流和维护，特此收集。

1.1边界定义

规范主要应用于Teradata SQL 的DML以下几个语句编写约定

Select  语句；

Insert  语句；

Delete 语句；

逻辑判断语句；

类型转换语句；

以及相关的Teradata 函数、

Teradata 数据仓库项目实施过程中数据表现形态约定等内容

1.2 原则定义

1、 要求代码行清晰、整齐，具有一定的可观赏性；

2、 代码编写要充分考虑执行速度最优的原则；

3、 代码行整体层次分明、结构化强；

4、 代码中应有必要的注释以增强代码的可读性；

5、 规范要求非强制性约束代码开发人员的代码编写行为，在实际应用中在不违反常规要求的前提下允许存在可理解的偏差。

2. 格式编排规范

2.1 注释约定

对于较为复杂的数据操作例程应有充分的注释，注明实现的功能，业务逻辑关系输入输出关系等内容，对于修改脚本，需在注释中标明修改人、修改时间。

注释中应包含以下内容：

脚本头注释：

脚本头的注释中需要注明修改人、修改时间、修改目的。

脚本行注释：

对于脚本中的硬编码需要注明含义。

单行或多行注释都用 ’ /*   */’ 来标识。

注释中不可出现“@”符号。

脚本块注释：