SQL - 註解：初學者的友好指南

你好，有抱負的SQL愛好者！我很高興能成為你進入SQL註解世界的引路人。作為一個教了多年計算機科學的人，我可以告訴你，理解註解就像學會在代碼中留下有用的便利貼紙。那麼，我們就來一起深入探討，讓這個過程變得有趣吧！

SQL - Comments

SQL註解是什麼？

在我們深入細節之前，我們先來了解一下SQL註解是什麼，以及它們為什麼如此重要。想象一下你在寫一本菜譜。難道加上一點關於為什麼選擇某些食材或技巧的小筆記不是很方便嗎？這正是註解在SQL中的作用！

註解是你的SQL代碼中的文本片段，數據庫引擎會忽略它們。它們作為給自己或其他程序員的筆記，解釋你的代碼是做什麼的，或者你為什麼這樣寫。相信我，你未來的自己會為你留下這些面包屑而感謝！

SQL註解的類型

在SQL中，我們主要有兩種註解類型：

單行註解
多行註解

讓我們詳細探討每一種，好嗎？

單行註解

單行註解非常适合快速解釋或短筆記。它們以兩個連字符（--）開始，並持續到行尾。這是它們的樣子：

-- 這是一個單行註解
SELECT * FROM Customers; -- 這個選擇了所有客戶

在這個例子中，我們有兩個單行註解。第一個在自己的行上，第二個在SQL語句的末尾。兩者都是有效的！

讓我們看一個更實際的例子：

-- 检索過去30天內下的所有訂單
SELECT OrderID, CustomerName, OrderDate
FROM Orders
WHERE OrderDate >= DATE_SUB(CURDATE(), INTERVAL 30 DAY);

在這裡，註解解釋了查詢的作用，使任何閱讀代碼的人都能快速理解其目的。

多行註解

現在，如果你需要寫一個更長的解釋呢？這就是多行註解派上用場的地方！這些註解以 /* 開始，以 */ 結束。這些符號之間的一切都被視為註解，即使它們跨越多行。

這是一個例子：

/* 這個查詢將客戶和訂單表連接起來
找出過去一個月內下訂單的客戶。
它用於我們的每月客戶參與報告。 */
SELECT DISTINCT C.CustomerName, C.Email
FROM Customers C
JOIN Orders O ON C.CustomerID = O.CustomerID
WHERE O.OrderDate >= DATE_SUB(CURDATE(), INTERVAL 1 MONTH);

這不是很棒嗎？你可以寫下你所需要的內容，而不必擔心在每行添加 --。

使用SQL註解的最佳實踐

現在你知道了如何寫註解，讓我們來談談如何有效地使用它們。以下是我多年教學中總結的一些技巧：

清晰簡潔：寫下有價值的註解。避免 stating the obvious（這裡原文有一個錯誤，應為 "avoid stating the obvious"，即避免說明顯而易見的事情）。
用註解解釋原因，而非做了什麼：代碼本身顯示了正在做什麼。用註解來解釋為什麼這樣做。
保持註解更新：如果你更改了代碼，請確保更新相關的註解！
對複雜查詢使用註解：如果查詢特別複雜，請用註解分解每一部分。
為了測試而將代碼註解掉：你可以使用註解暫時禁用SQL代碼的一部分進行測試。

讓我們看一個結合了一些這些實踐的例子：

/* 客戶細分查詢
目的：根據總訂單金額细分客戶
最後更新：2023-05-15 */

SELECT
C.CustomerID,
C.CustomerName,
SUM(O.TotalAmount) AS TotalSpent,
CASE
WHEN SUM(O.TotalAmount) > 10000 THEN 'High Value'
WHEN SUM(O.TotalAmount) > 5000 THEN 'Medium Value'
ELSE 'Low Value'
END AS CustomerSegment
FROM
Customers C
JOIN
Orders O ON C.CustomerID = O.CustomerID
-- GROUP BY C.CustomerID, C.CustomerName
GROUP BY 1, 2  -- 使用列位置進行分組
HAVING
TotalSpent > 0;  -- 排除沒有訂單的客戶

在這個例子中，我們在頂部使用了一個多行註解來解釋查詢的目的和最後更新時間。我們還使用了一個單行註解來顯示GROUP BY子句的一種替代寫法，以及另一個來解釋為什麼使用HAVING子句。

結論

好了，各位！你剛剛學會了SQL註解的藝術。記住，好的註解就像好的禮貌一樣——它讓一切變得更順暢、更愉快。無論你是用單行註解快速筆記還是用多行註解提供詳細解釋，你都在使你的SQL代碼更具可讀性和可維護性。

在你繼續你的SQL之旅時，養成給代碼添加註解的習慣。你的同事（和未來的你）會感激你。快樂編程，願你的查詢總是運行順利！

註解類型	語法	使用案例
單行	`-- 註解文本`	快速解釋，短筆記
多行	`/* 註解文本 */`	長解釋，文檔

Credits: Image by storyset