SQL代码规范

这是万物可述的第31篇原创文章

一．规范在开发中的作用

1. 增加可读性

2. 定位Bug位置

3. 方便后期代码维护

4. 体现开发人员素养

二．常见的规范格式&工具(Notepad++)

1. 缩进

   最常见的缩进为空格、Tab键和换行。

2. 大小写

   通常可用小写。具体视项目组要求，有些项目组会要求关键字(如SELECT、FROM、WHERE等)大写，其余小写。

3. SQL规范样例

以下针对使用Notepad++工具进行说明

• SQL关键字高亮设置：

  【语言->S->SQL】

• 空白字符替换：

  【设置->首选项->语言 制表符设置->[Default]->制表符宽度&替换为空格】

  【编辑->空白字符操作->TAB转空格】

• 相同变量名高亮设置：

  【设置->首选项->高亮 智能高亮->仅匹配完整词&高亮延伸至另一窗口】

  
  

• 大小写关键字切换：

  【设置->管理快捷键  30-转成大写、31-转成小写】

三．常用快捷键说明

Shift键：全选(结合Home、End、上下左右方向键)、反向选择

Tab键：常用的缩进键(结合Shift键可反向缩进)

Alt键：列块模式、区域定位、菜单栏选择

Ctrl键：结合设置的快捷键(该键常与其他键组合构成快捷键)

四．常见的规范方法

1. 程序块关键字对齐(begin、decalre、end)

2. select后的各行首字母对齐

3. AS对齐

4. 注释对齐

5. 同一层级关键字(居右)对齐并换行

五．规范说明(摘自Dora的博客)

进行SQL和T-SQL编程时常常会忽略编码标准，但这些标准却是开发小组顺利开展工作的关键工具，SQL和T-SQL代码的格式似乎并不重要，但一致的格式可以使同事（不论是同一小组的成员还是更大范围的SQL和T-SQL开发团队的成员）更轻松地浏览和理解代码。

T-SQL语句有一个结构，遵循一目了然的结构可以更轻松地查找和确认语句的不同部分,可以加快开发效率。

(详见链接：http://blog.sina.com.cn/s/blog_5f90da9b0102v00c.html)

• 书写标准

缩进

1. 一般缩进为4个空格。

2. 不要用Tab制表符来作缩进。
   

换行

1. Select/From/Where/Order by/Groupby等子句必须另起一行写。
   

2. Select子句内容如果只有一项，与Select同行写。
   

3. Select子句内容如果多于一项，每一项单独占一行，在对应Select的基础上向右缩进4空格。
   

4. From子句内容如果只有一项，与From同行写。
   

5. From子句内容如果多于一项，每一项单独占一行，在对应From的基础上向右缩进4空格。
   

6. Where子句的条件如果有多项，每一个条件占一行，以AND或者OR开头，在对应Where的基础上向右缩进4空格。
   

7. (Update)Set子句内容每一项单独占一行，无缩进。
   

8. Insert子句内容每个表字段单独占一行，无缩进。
   

9. values每一项单独占一行，不缩进。

10. SQL文中间不允许出现空行。

11. 存储过程或函数输入参数命名以in开头，如@in_Year;输出参数以out开头，如@out_money;局部变量有字母小写，第二个单词起的每个单词的首字母大写，不使用“_”，如@customerCount;

空格

1. 连接符or、in、and、以及=、<=、>=等前后加上一个空格。

2. 逗号之后必须接一个空格。

3. 关键字、保留字和左括号之间必须有一个空格。
   

作者：张铭松

编辑：徐菲