# 使用 SQL Server Management Studio 設定資料表描述

[](https://hackmd.io/oro6bUlLSRyBke7gNGYnLA)

一般來說，為了讓人了解資料表的用途和結構，我們會在資料表中設定描述。這不僅有助於文件化資料庫結構，還能支援開發工具產生 Table Schema 文件。

資料表欄位的描述可以在設計功能進行編輯，而資料表雖然乍看之下沒有設定描述的選項，但實際上仍然可以進行設定，以下進行說明。

## 使用 SSMS 設定
1. 在 SQL Server Management Studio (SSMS) 中，右鍵點擊目標資料表，選擇「屬性」。
2. 在「屬性」視窗中，進入「擴展屬性」頁面，新增屬性 `MS_Description`，輸入資料表的描述。

:::warning
畫面旁邊的三個點的按鈕，點擊會跳出可多行編輯的 UI 視窗。若使用 Entity Framework 反向工程，請避免使用多行描述，以免導致生成無法編譯的程式碼。。
:::

### 2024-08-23
突然發現在資料表設計模式的屬性視窗就可以直接編輯資料表描述了，如下圖。難怪我一直記得早期設定資料表描述沒那麻煩...

## 使用 SQL 語法編輯
可以透過以下 SQL 語法來設定或修改資料表描述：

### 增加資料表描述

EXECUTE sp_addextendedproperty @name = N'MS_Description', @value = N'{資料表描述}', @level0type = N'SCHEMA', @level0name = N'dbo', @level1type = N'TABLE', @level1name = N'{資料表名稱}';

### 修改資料表描述

EXECUTE sp_updateextendedproperty @name = N'MS_Description', @value = N'{資料表描述}', @level0type = N'SCHEMA', @level0name = N'dbo', @level1type = N'TABLE', @level1name = N'{資料表名稱}';

## 異動歷程
* 2024-07-24 新增。
* 2024-08-23 增加 SSMS 第二種設定方式。

###### tags: `Database` `Microsoft SQL Server`