浅谈SQL命名与注释规范

  • 来源: 程序员之家 作者: sevenleaf   2010-04-16/10:02
  •       SQL编程对于操作数据库人员来说无疑是一种提高效率的方法,但是有些刚入门数据库管理人员对于编程的规范视而不见,他们总是认为达到自己想要的结果就好,可是他们却忽略了性能以及优化的问题,今天小编和大家分享一些SQL命名规范希望对大家有所帮助。
    一.常见命名规则有四种样式:完全大写、完全小写、Pascal 大小写和 Camel 大小写。
          1. Camel 大小写
          标识符的首字母小写,每个后面连接的单词的首字母大写,其余字母小写的书写约定。对于缩写的双字母单词,要求它们出现在标识符首部时全部小写,否则全部大写。
          例如:applicationException
                   id
          2. Pascal 大小写
          组成标识符的每个单词的首字母大写,其余字母小写的书写约定。对于缩写的双字母单词,要求全部大写。
          例如:ApplicationException
                   ID
          3. 匈牙利命名法
          匈牙利命名法由匈牙利程序员发明,他在微软工作了多年,此命名法就是通过微软的各种产品和文档传出来。多数有经验的程序员,不管他们用的是哪门语言,都或多或少在使用它。
          基本原则:变量名 = 属性 + 类型 + 对象描述
          即一个变量名是由三部分信息组成,这样,程序员很容易理解变量的类型、用途,而且便于记忆。
          说到命名规范,让我不禁想到代码的注释,之前从事开发工作的时候,由于注释不到位再加上编码不规范的问题,使团队的其他成员很难看懂,严重的造成项目延期。所以下面小编也要和大家说下注释规范,所谓没规矩不成方圆嘛!
    二.代码注释规范
          1 代码头部注释
          在SQL代码块(sql文件或存储过程)的头部进行注释,标注创建人(Author)、创始日期(Create date)、修改信息(Modify [n])。
          格式:
    -- =============================================
    -- Author:      <Author,,Name>
    -- Create date: <Create Date,,>
    -- Description: <Description,,>
    -- Modify [n]:  < Modifier,Date, Description >
    -- =============================================
          示例:
    -- ================================================
    -- Author:      Zhanghaifeng
    -- Create date: 2006-12-25
    -- Description: H2000报关单回执处理
    -- Modify [1]:  郑佐, 2006-12-31, 简化逻辑判断流程
    -- Modify [2]:  郑佐, 2007-01-20, 更新条件判断
    -- ================================================
          注:日期格式使用 yyyy-MM-dd。Modify [n] n代表修改序号,从1开始,每次修改加1。
          2. TRANSACTION注释
          建议在每个事务的开头进行注释,说明该事务的功能。
    -- < Modifier,Date, Description >
    BEGIN TRANSACTION;


    评论 {{userinfo.comments}}

    {{money}}

    {{question.question}}

    A {{question.A}}
    B {{question.B}}
    C {{question.C}}
    D {{question.D}}
    提交

    驱动号 更多