漫談數(shù)據(jù)庫(kù)SQL語(yǔ)言(1)：從注釋談起

數(shù)據(jù)庫(kù)是個(gè)通用化的綜合性的數(shù)據(jù)集合，它可以供各種用戶共享且具有最小的冗余度和較高的數(shù)據(jù)與程序的獨(dú)立性。目前，國(guó)際上主導(dǎo)的大型數(shù)據(jù)庫(kù)管理系統(tǒng)有ORACLE、SQL SERVER、SYBASE、INFORMIX和INGRES等。 數(shù)據(jù)庫(kù)中常用的編程語(yǔ)言是SQL語(yǔ)言，按其功能可分為四

數(shù)據(jù)庫(kù)是個(gè)通用化的綜合性的數(shù)據(jù)集合，它可以供各種用戶共享且具有最小的冗余度和較高的數(shù)據(jù)與程序的獨(dú)立性。目前，國(guó)際上主導(dǎo)的大型數(shù)據(jù)庫(kù)管理系統(tǒng)有ORACLE、SQL SERVER、SYBASE、INFORMIX和INGRES等。

數(shù)據(jù)庫(kù)中常用的編程語(yǔ)言是SQL語(yǔ)言，按其功能可分為四大部分：

(1) 數(shù)據(jù)定義語(yǔ)言(Data Definition Language)，用于定義、撤銷和修改數(shù)據(jù)模式。

(2) 數(shù)據(jù)查詢語(yǔ)言(Data Query Language)，用于查詢數(shù)據(jù)。

(3) 數(shù)據(jù)操縱語(yǔ)言(Data Manipulation Language)，用于增、刪、改數(shù)據(jù)。

(4) 數(shù)據(jù)控制語(yǔ)言(Data Control Language)，用于數(shù)據(jù)訪問(wèn)權(quán)限的控制。

其中，數(shù)據(jù)定義語(yǔ)言包括CREATE、DROP和ALTER語(yǔ)句，數(shù)據(jù)查詢語(yǔ)言包括SELECT語(yǔ)句，數(shù)據(jù)操縱語(yǔ)言包括UPDATE、DELETE和INSERT語(yǔ)句，數(shù)據(jù)控制語(yǔ)言包括GRANT語(yǔ)句。

在數(shù)據(jù)庫(kù)中，除了以上四種SQL語(yǔ)言外，還涉及到表、索引、存儲(chǔ)過(guò)程和事務(wù)等概念，它們?cè)趯?shí)際編程中也是不可或缺的。

1. 概述

注釋在程序語(yǔ)言的編寫中占有非常重要的地位。優(yōu)美的、得當(dāng)?shù)淖⑨尣粌H有助于研發(fā)人員理解程序，還能夠提高編程效率(進(jìn)而提高辦事效率)。

但是，可能是由于工作比較忙的緣故，許多開(kāi)發(fā)人員不重視注釋的書寫，這也導(dǎo)致了項(xiàng)目交接的時(shí)候，其他開(kāi)發(fā)人員理解程序困難，甚至不知道程序到底要做什么事情。因此，良好注釋的書寫是對(duì)一個(gè)開(kāi)發(fā)人員的基本要求，大家一定要重視。

對(duì)于腳本的注釋，建議大家一律采用英文，這樣可以體現(xiàn)出國(guó)際化、專業(yè)性與規(guī)范性。

2. 數(shù)據(jù)庫(kù)腳本文件頭部的注釋

很多腳本文件都沒(méi)有頭部的注釋，大家認(rèn)為它不重要。但作者認(rèn)為一定要把這部分內(nèi)容加上，這樣為以后追蹤版本信息提供了方便。

在文件頭部的注釋中，要包括版權(quán)、數(shù)據(jù)庫(kù)類型、創(chuàng)建日期、作者、修改記錄等信息，可以采用以下的樣式：

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

-- 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. 數(shù)據(jù)庫(kù)腳本文件摘要信息的注釋

在頭部注釋之后，不要馬上就開(kāi)始創(chuàng)建表及存儲(chǔ)過(guò)程，而應(yīng)該有一個(gè)摘要。如果是建表腳本，摘要就是該文件中包括的表的名稱和用途；如果是創(chuàng)建存儲(chǔ)過(guò)程的腳本，摘要就是該文件中包括的存儲(chǔ)過(guò)程的名稱和用途。這個(gè)摘要可以起到索引的作用，幫助開(kāi)發(fā)人員了解腳本文件的主要內(nèi)容。

摘要信息的注釋可以采用以下的樣式：

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

--* 1 table1 : description1

--* 2 table2 : description2

--* 3 table3 : description3

. . . . . .

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

4. 表或存儲(chǔ)過(guò)程開(kāi)頭處的注釋

在表或存儲(chǔ)過(guò)程的開(kāi)頭處添加注釋，可以起到方便定位、易于查閱的作用?？梢圆捎靡韵碌臉邮剑?/p>

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

The definition of the table or procedure

5. 表的各字段之后的注釋

在定義了一個(gè)表的各字段之后，需要對(duì)每個(gè)字段進(jìn)行注釋，以方便研發(fā)人員了解其作用，避免猜測(cè)和錯(cuò)誤理解。這樣，使用起來(lái)也會(huì)得心應(yīng)手。

表的定義及字段注釋可以采用以下的樣式：

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. 存儲(chǔ)過(guò)程的注釋

一般說(shuō)來(lái)，存儲(chǔ)過(guò)程包括的SQL語(yǔ)句比較多，因此注釋也會(huì)比較的復(fù)雜。即便是這樣，在一些關(guān)鍵語(yǔ)句的地方，一定要有注釋，否則其他開(kāi)發(fā)人員閱讀起來(lái)就會(huì)比較費(fèi)勁。

存儲(chǔ)過(guò)程的編寫及注釋可以采用以下的樣式：

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. 總結(jié)

注釋的作用是錦上添花，不恰當(dāng)?shù)淖⑨尣坏荒軌蚱鸬綉?yīng)有的作用，反而有可能讓人產(chǎn)生誤解。因此，我們?cè)谔砑幽_本文件注釋的時(shí)候，一定要遵循簡(jiǎn)單、清晰、明了、通俗易懂的原則。

聲明：本網(wǎng)頁(yè)內(nèi)容旨在傳播知識(shí)，若有侵權(quán)等問(wèn)題請(qǐng)及時(shí)與本網(wǎng)聯(lián)系，我們將在第一時(shí)間刪除處理。TEL:177 7030 7066 E-MAIL:11247931@qq.com