如何描述一張資料表的基本資訊？

最近，我和一位同僚合作設計資料庫表。我們在設計好各個表之後，需要将表的基本資訊記錄下來，發給同項目組的同僚參閱和評審。最開始，我們不是很清楚如何來描述每張表的資訊。通過與大家商量之後，我們認為通過如下格式描述資料庫表的基本資訊比較恰當。本文可供有類似需求的開發人員參考。

要比較完整地描述一張資料表，需要交代清楚這五個部分：總體說明、版本說明、表結構說明、建表腳本、初始化語句。以下以員工資訊表為例加以說明：

1. 總體說明(表存放資料說明，哪些子產品使用)

員工資訊表tb_employeeinfo，通過此表可定義每個員工在資料庫中存儲的基本資訊。

使用子產品：員工資訊存儲及處理子產品。

2. 版本說明(在哪個基線的哪個版本上增加，誰增加的)

XXX在V1.01.01版本基礎之上增加。

3. 表結構說明(必須标明那個字段是主鍵)

                                                               員工資訊表tb_employeeinfo

字段名稱

資料類型

是否可空

字段描述

employeeno

varchar2(20)

N

員工工号，在此字段上建立唯一索引

employeename

varchar2(50)

員工姓名

employeeage

int

員工年齡

employeeaddr

varchar2(100)

Y

員工位址

4. 建表腳本(基于OEACLE資料庫實作)

5. 初始化語句

初始時隻存儲一個員工的資訊，初始語句如下：