脚本编写规范
开始部分
口径开始部分已注明口径的相关信息,具体包括口径编码、口径名称、口径功能、口径实现时间、编写人。变更口径内容是,必须注明变更人、变更时间、变更信息。口径编码必须大写。
中间过程
1)临时表
取数据过程中只能用临时表,不能使用结果表。只能在口径末尾更新结果表,防止在口径执行过程中,结果表的数据重复变化。
2)动态逻辑
确保口径不出现常量,必须通过设定变量并进行赋值来实现,以避免程序写死导致出错或调整编码的大量改动。
3)代码排版
以 Tab为一缩进层次,各个层次之间必须缩进,保证口径排版清晰。
4)大小写规范
关键词大写,如SELECT、FROM 、WHERE 、GROUP BY 、ORDER BY 等。
5)业务注释
1 每一段sql都必须有简洁明了的业务注解。
2 每个表字段必须要求有注释。
6)索引
每个结果表的关键字段都应该有索引,提高模块查询数据的速度。
结束部分
在口径结束部分,必须把当前口径的临时表全部删除。
表命名规范
1、首字母小写,驼峰命名(小驼峰命名)。
2、禁止混搭拼音与中文,名字尽量要长,需要清晰的描述业务(例如:xiangYiFu)。
代码注释说明
1、单行注释:以#符号进行注释。
2、多行注释:用三引号包含注释内容,可以是三对单引号,也可以是三对双引号。
示例:
日志输出要求
对每一段DDL,DML进行日志输出,包含:执行结果,执行内容,执行时间,执行参数。
日志输出