Oracle COMMENT 語句為資料表、欄位、視圖新增中文註解完整指南

使用 COMMENT 命令建立自描述資料字典

Oracle COMMENT 指令可為資料表、欄位、視圖、Materialized View、Operator、Indextype 等物件新增說明文字，存儲於資料字典，供開發、維護、文件產生工具讀取。

基本語法

-- 資料表註解
COMMENT ON TABLE table_name IS '註解內容';

-- 欄位註解
COMMENT ON COLUMN table_name.column_name IS '註解內容';

-- 視圖註解
COMMENT ON TABLE view_name IS '註解內容';  -- 視圖同 TABLE

權限要求

• 預設：物件擁有者可註解自有物件
• 註解他人物件：需 COMMENT ANY TABLE 系統權限

相關資料字典視圖

完整實戰範例

-- 1. 建立測試表
DROP TABLE t PURGE;
CREATE TABLE t (id NUMBER);

-- 2. 查詢預設註解（為空）
SELECT * FROM user_tab_comments WHERE table_name='T';
SELECT * FROM user_col_comments WHERE table_name='T';

-- 3. 新增註解
COMMENT ON TABLE t IS '測試表T';
COMMENT ON COLUMN t.id IS '行ID';

-- 4. 驗證結果
SELECT * FROM user_tab_comments WHERE table_name='T';
-- TABLE_NAME  TABLE_TYPE  COMMENTS
-- T           TABLE       測試表T

SELECT * FROM user_col_comments WHERE table_name='T';
-- TABLE_NAME  COLUMN_NAME  COMMENTS
-- T           ID           行ID

最佳實踐建議

1. 建表即註解：DDL 腳本包含 COMMENT，納入版控
2. 命名規範：業務術語統一、中英文對照、避免縮寫歧義
3. 自動化文件：結合 USER_TAB_COMMENTS/USER_COL_COMMENTS 產生資料字典文件
4. 敏感資料標記：標註 PII、加密、法規相關欄位

良好的註解習慣是降低維護成本、加速新人上手、支援自動化治理的基礎投資。將 COMMENT 納入開發規範與 Code Review 清單。