让你提前认识软件开发(26)：数据库脚本的凝视

第2部分 数据库SQL语言

数据库脚本的凝视

1. 概述

        凝视在程序语言的编写中占有非常重要的地位。优美的、得当的凝视不仅有助于研发人员理解程序，还能够提高编程效率(进而提高办事效率)。

        可是，可能是因为工作比較忙的缘故，很多开发者不重视凝视的书写，这也导致了项目交接的时候，其它开发者理解程序困难。甚至不知道程序究竟要做什么事情。因此，良好凝视的书写是对一个开发者的基本要求，大家一定要重视。

        对于脚本的凝视。建议大家一律採用英文，这样能够体现出国际化、专业性与规范性。

2. 数据库脚本文件头部的凝视

        非常多脚本文件都没有头部的凝视，大家觉得它不重要。但作者觉得一定要把这部分内容加上，这样为以后追踪版本号信息提供了方便。

        在文件头部的凝视中，要包含版权、数据库类型、创建日期、作者、改动记录等信息，能够採用下面的样式：

--*********************************************************************

-- copy right (C)2014, company name.

-- DB Type: XXX

-- Content: XXX

-- Created: YYYY.MM.DD

-- Modify1: The name of the author

-- Date1: YYYY.MM.DD

-- version1: The original version of the product

-- Modify2: The name of who modified the file

-- Date2: YYYY.MM.DD

-- version2: The updated version of the product

--**********************************************************************

3. 数据库脚本文件摘要信息的凝视

        在头部凝视之后。不要立即就開始创建表及存储过程，而应该有一个摘要。假设是建表脚本，摘要就是该文件里包含的表的名称和用途。假设是创建存储过程的脚本，摘要就是该文件里包含的存储过程的名称和用途。

这个摘要能够起到索引的作用，帮助开发者了解脚本文件的主要内容。

        摘要信息的凝视能够採用下面的样式：

--********* XXX(Version)DataBase Table Creating*********

--*  1    table1                : description1

--*  2    table2                : description2

--*  3    table3                : description3

    . . . . . .

--***************************************************

4. 表或存储过程开头处的凝视

        在表或存储过程的开头处加入凝视，能够起到方便定位、易于查阅的作用。能够採用下面的样式：

-- XXX(The name of the table or procedure, and what it is used for)

The definition of the table or procedure

5. 表的各字段之后的凝视

        在定义了一个表的各字段之后，须要对每一个字段进行凝视。以方便研发人员了解其作用。避免推測和错误理解。

这样，使用起来也会得心应手。

        表的定义及字段凝视能够採用下面的样式：

create table tb_XXX

 (

    AAA               int                                   not null,          -- description1

    BBB              varchar(256)                 not null,          -- description2

    CCC              int default(0)                        null,          -- description3

    DDD             varchar(256)  default(‘‘‘‘)   null,         -- description4

    . . . . . .

)

6. 存储过程的凝视

        一般说来。存储过程包含的SQL语句比較多，因此凝视也会比較的复杂。即便是这样，在一些关键语句的地方，一定要有凝视。否则其它开发者阅读起来就会比較费劲。

       存储过程的编写及凝视能够採用下面的样式(以Sybase数据库中的语法为例)：

create procedure pr_XXX

    @AAA          varchar(30),        -- description1

    @BBB          int,                       -- description2

    . . . . . .

as

begin

declare

    @CCC          int,                       -- description3

@DDD          varchar(100),        -- description4

    . . . . . .

   . . . . . .

    -- YYY(name) add YYYYMMDD for ZZZ begin

    . . . . . .

    -- YYY(name) add YYYYMMDD for ZZZ end

    . . . . . .

    statement1                    -- YYY add YYYYMMDD description5

    . . . . . .

    statement2                    -- YYY modify YYYYMMDD description6

     . . . . . .

    statement3                    -- YYY delete YYYYMMDD description7

    . . . . . .

    . . . . . .

    statement4                    -- description8(important statement)

    . . . . . .

end

7. 有关凝视的一些规则和建议

(1) 统一使用“--”进行凝视(不要使用“/* */进行凝视”)。
(2) 脚本文件头部必须进行凝视。

(3) 每段完毕一定功能的脚本前(如创建数据表、存储过程、任务、插入缺省记录等)。均应有凝视说明。

(4) 创建数据表中每一个字段后应有凝视。说明字段含义，有些还须要说明取值范围等。

(5) 创建存储过程和函数中每一个输入输出參数后应有凝视，说明參数含义，有些还须要说明取值范围等。

(6) 对分支语句(包含条件分支)、循环语句等要编写凝视。

(7) 保证代码和凝视的一致性。改动代码同一时候改动对应的凝视，不再实用的凝视要删除。

(8) 凝视应与其描写叙述的代码相近。对代码的凝视应放在其上方或右方(对数据表中字段和存储过程參数的凝视)相邻位置。不可放在下面。如放于上方则需与其上面的代码用空行隔开。

(9) 凝视与所描写叙述代码进行相同的缩排。

(10) 中文版本号的凝视统一使用中文描写叙述，海外版本号的凝视统一使用英文描写叙述。

(11) 通过对函数或过程、变量等正确的命名以及合理地组织代码结构，使代码成为自凝视的。

(12) 尽量避免在凝视中使用缩写，特别是不经常使用缩写。

8. 总结

        凝视的作用是锦上添花，不恰当的凝视不但不能够起到应有的作用，反而有可能让人产生误解。因此。我们在加入脚本文件凝视的时候，一定要遵循简单、清晰、明了、通俗易懂的原则。

(本系列文章每周更新两篇，敬请期待！本人微博：http://weibo.com/zhouzxi?topnav=1&wvr=5，微信号：245924426，欢迎关注！)