SQL 註解 (SQL Comments)

在撰寫 SQL 語句時,我們可以加入註解來說明程式碼的用途,讓自己或其他開發者日後更容易理解。註解不會被資料庫執行,純粹是給人閱讀的說明文字。

單行註解

使用兩個連字號 -- 開頭,後面接著註解文字。從 -- 到該行結尾的內容都會被視為註解:

-- 這是一個單行註解
SELECT * FROM customers;

也可以將註解放在 SQL 語句的後面:

SELECT * FROM customers; -- 查詢所有客戶資料

或是放在語句中間:

SELECT Name, -- 客戶姓名
       City  -- 所在城市
FROM customers;

多行註解

使用 /* 開始,*/ 結束。這種方式可以註解多行內容:

/*
這是多行註解
可以寫很多說明文字
不會被執行
*/
SELECT * FROM customers;

多行註解也可以用在語句中間,暫時停用某段程式碼:

SELECT Name, City /*, Address, Phone */ FROM customers;

上面這個例子中,Address 和 Phone 欄位被註解掉了,不會被查詢。

使用 # 號註解 (MySQL)

在 MySQL 中,還可以使用 # 符號來做單行註解:

# 這是 MySQL 專用的註解方式
SELECT * FROM customers;

號註解是 MySQL 特有的語法,不是 SQL 標準,在其他資料庫(如 SQL Server、Oracle、PostgreSQL)中無法使用。

註解的用途

  1. 說明程式碼用途:讓其他開發者更容易理解你的 SQL 語句
  2. 暫時停用程式碼:在除錯時,可以快速註解掉某段程式碼而不用刪除它
  3. 版本紀錄:記錄誰在什麼時候修改了這段程式碼