Sql 代码规范说明

对于程序工作者来说,代码的阅读必不可少,好的代码让人读起来一目了然、神清气爽,做代码调试也可以很开的捋顺逻辑定位问题,但是如果遇到一些可读性较差,毫无规矩可言的代码,那真的比吃了翔都难受啊,如果再让你在这个基础上做点东西或者持续维护这些代码,真的能让人憋屈死,所以代码的书写必须条理清晰,遵循规矩,虽说SQL 的代码语法相比其他的java、python 等高级语言要差了几个档,但是对于一门数据查询语言来说,语法简答并不意味着没有结构可言,接下来我们共同学习一下SQL 的代码规范。

我们分别从代码的注释、主体结构和最终的脚本命名三个方面讨论SQL 的规范:

  • 代码的注释:

1、代码块的注释使用 " /* .... */“
   每个SQL 查询代码的开始段,必须对整个代码进行简单的说明,说明内容包括:书写人、业务内容、书写时间、注意事项等;
2、不换行的简单注释,在注释文字前用" -- “
  1)针对字段的解释,放到这个字段后面;
    EG:count(distinct salesNo) as CustNum  -- 统计是客流量
  2)针对行的解释,一般会单独取一行,避免某行代码过长;
    EG :-- 2017年7月2号计算每个会员购买金额占总体金额的比

  •  主体结构规范:

    1、查询相关关键字单独再起一行;select /from /where/group by /having/order by;

    2、select 之后的字段 之间使用 ‘,’分隔,逗号统一放到各字段的前面或者后面;

    3、select 的相关字段,一般是缩进4个空格或者6个空格;

    4、代码的分号一般放到代码的结尾;

    5、对于子查询嵌套使用规则:

        1)子查询语句使用()进行包裹,子查询语句单独另起一行;

        2)同一级别的子句内部要对齐;

    6、表别名命名规则:

        1)表一定要有别名例如:单个字母,字母加数字;

        2)多个表(t特别是有子查询嵌套查询)在关联的时候有相应临时表命名有顺序,例如:t1,t2,t3;A,B,C;

  • 脚本命名

    1)代码开发完成后,及时进行代码保存;

    2)文件格式:.sql 结尾脚本命名;

    3)名字缩写+内容+日期;

原文地址:https://www.cnblogs.com/hello-alan/p/11486218.html