SQL编码规范教材
合集下载
相关主题
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
30-Jan-19
www.si-tech.com.cn
E-SQL排版规则
规则2.11 在EXEC SQL语句后加一个TAB键,然后再写SQL语句。 规则2.12 SQL语句的关键字SELECT、FROM、WHERE、AND等,必须尾部对齐。 规则2.13 语句的结束符“;”,放在语句的结束位置,不单独起一行。 规则2.14 SQL语句中不能有注释,如“/**/”、“--”等,注释写在SQL语句的外面。
30-Jan-19
www.si-tech.com.cn
神州数码思特奇公司基础工程师系列培训
一般规则
规则2.9 空格: SQL内算数运算符、逻辑运算符连接的两个元素之间必须用空格分隔。 逗号之后必须接一个空格。 关键字、保留字和左括号之间必须有一个空格。 规则2.10 大小写规则 SQL 语句中出现的系统保留字、内置函数名、SQL保留字、绑定变量等都应大 写。
30-Jan-19
www.si-tech.com.cn
神州数码思特奇公司基础工程师系列培训
一般规则
规则2.7 循环语句: 循环开始语句(FOR、WHILE)跟LOOP语句分行。 END LOOP语句,跟LOOP在同一列位置。 示例: FOR v_Index IN 1..20 LOOP …… END LOOP;
30-Jan-19
www.si-tech.com.cn
神州数码思特奇公司基础工程师系列培训
范围
本规范定义了所有代码编写者在编写SQL程序时应遵守 的一些规则和习惯。 本规范采用以下术语描述: 规则:编程时强制必须遵守的原则。 建议:编程时必须加以考虑的原则。 说明【 】:对此规则或建议进行必要的解释。 示例:对此规则或建议从正、反两个方面给出例子。
一般规则
规则2.1 独立单元书写规则: 整个文件,以过程、函数或包为相对独立的单元。在每个单位中,采用以下统一 格式。 示例: CREATE or REPLACE …… AS …… BEGIN …… EXCEPTION …… END; 即:CREATE、AS、BEGIN、EXCEPTION和END,在第1列。后面的内容,间隔1 个TAB书写。 除非内部处理,否则一律带上EXCEPTION。
30-Jan-19
www.si-tech.com.cn
神州数码思特奇公司基础工程师系列培训
提纲
2
概述 排版规则 注释规则 命名规范 SQL程序编码规则 SQL性能规则与建议 程序质量保证 安全保障
2.1一般规则 2.2 E-SQL排版规则
30-Jan-19
www.si-tech.com.cn
神州数码思特奇公司基础工程师系列培训
神州数码思特奇公司基础工程师系列培训
提纲
1
概述 排版规则 注释规则 命名规范 SQL程序编码规则 SQL性能规则与建议 程序质量保证 安全保障
1.1 概述 1.2 范围
30-Jan-19
www.si-tech.com.cn
神州数码思特奇公司基础工程师系列培训
概述
制定编码规范的最主要的目的是为了对产出代码的长期 维护。通常负责维护代码的人大多都不是开发者本人,如果 有一个统一的代码格式以及说明就可以减少混淆提高理解速 度。因此,下列的编码规范是基于良好的编码习惯和可读性 的原则来制定的。
30-Jan-19
www.si-tech.com.cn
神州数码思特奇公司基础工程师系列培训
提纲
2
概述 排版规则 注释规则 命名规范 SQL程序编码规则 SQL性能规则与建议 程序质量保证 安全保障
2.1一般规则 2.2 E-SQL排版规则
30-Jan-19
www.si-tech.com.cn
来自百度文库
神州数码思特奇公司基础工程师系列培训
30-Jan-19
www.si-tech.com.cn
神州数码思特奇公司基础工程师系列培训
一般规则
规则2.5 程序块间隔行规则: SQL程序块之间,采用1行空行分隔。适当时候,可以存在2行空行,不要超过2 行(注释行不在此约定范围内)。 规则2.6 IF语句: IF语句是条件判断语句,只有一个条件的时候,可以不用圆括号。两个以上条件 的时候,要求用圆括号(),使得逻辑处理明晰。 IF/ELSIF/ELSE/END IF关键字,每个都独立占一行。且每行的开始列位置都相 同。 特别注意,结束语句END IF后面,有分号。
30-Jan-19
www.si-tech.com.cn
神州数码思特奇公司基础工程师系列培训
一般规则
规则2.7 循环语句: 一行最长不能超过80字符。当超过时,以语意为单位,进行断行,且断行后的内 容,缩进书写。 示例: -- 创建汇总基础表 Create_BaseDat -- p_BaseSQL in varchar -- SQL 语句 -- p_sResultTBL in varchar-- 结果输出数据表 -- p_sInfoStr in varchar-- 提示信息 --- 返回值:<0, 出错;=0, 无记录;>0记录数 Function CReate_BaseData(p_BaseSQL in varchar, p_sResultTBL in varchar, p_sInfoStr in varchar2) RETURN INT; 此外,SELECT/FROM/WHERE/ORDER BY/GROUP BY等子句必须另起一行写。
30-Jan-19 www.si-tech.com.cn
神州数码思特奇公司基础工程师系列培训
一般规则
规则2.2 块关键字对齐原则: 任何块的关键字,首字母在列上对齐。 即:一个程序块内部,标识程序块的关键字开始语句(IF、DO、FOR和BEGIN)、 中间语句(ELSIF、EXCEPTION、ELSE)和结束语句(END IF、END LOOP、END), 在列位置对齐。 规则2.3 块内缩进原则 即:一个块下属的内容,从下一行开始,从这个块的标识首字符右移一个tab键, 从右移一个tab键开始。 规则2.4 TAB/空格一致原则 即:一个源文件中,在内容缩进上,要么采用tab方式,要么采用4个空格方式。 不能二者并存。 强烈建议要求使用TAB对齐。