註解

註解 (Comment) 是程式碼中不會執行的文字字串，亦稱為備註 (Remark)。註解可以用來說明程式碼，或是把要診斷的 Transact-SQL 陳述式及批次的某些部分暫時取消作用。使用註解來說明程式碼可使後續的程式碼維護工作更加容易。註解經常是用來記錄程式名稱、作者姓名，以及主程式碼的修改日期。註解可以用來描述複雜的計算或說明程式撰寫的方法。

SQL Server 支援兩種類型的註解字元：

• -- (雙連字號)。這些註解字元可以如同程式碼放在同一行來執行，或是自己本身全部放在同一行。從雙連字號到該行結尾之間，全部都是註解的一部分。對於多行註解而言，雙連字號必須出現在每一行註解的前面。如需如何使用註解字元的詳細資訊，請參閱＜-- (註解) (Transact-SQL)＞。

• /* ...*/ (斜線-星號字元配對)。這些註解字元可以如同程式碼放在同一行來執行，也可以自己本身全部放在同一行，或甚至在可執行的程式碼中執行。從開始註解配對 (/*) 到結束註解配對 (*/) 之間，全部都會視為註解的一部分。對於多行註解而言，開始註解字元配對 (/*) 必須開始註解，而結束註解字元配對 (*/) 必須結束註解。如需如何使用 /* ...*/ 註解字元的詳細資訊，請參閱＜/*...*/ (註解) (Transact-SQL)＞。

考量因素

以下是有關註解的一些基本資訊：

• 所有英數字元或符號都可用於註解中。雖然 SQL Server Management Studio 程式碼編輯器與 sqlcmd 會在多行註解中搜尋 GO 作為行中的最前面兩個字元，但是 SQL Server 會忽略註解中的所有字元。

• 一個批次中的註解沒有長度的限制。一個註解可以包含一行或多行。

範例

下列為有效註解的一些範例。

USE AdventureWorks;
GO
-- Single line comment.

SELECT EmployeeID, Title
FROM HumanResources.Employee;
GO

/* First line of a multiple-line comment.
   Second line of a multiple-line comment. */
SELECT Name, ProductNumber, Color
FROM Production.Product;
GO

-- Using a comment in a Transact-SQL statement
-- during diagnosis.
SELECT ContactID, /* FirstName, */ LastName
FROM Person.Contact;

-- Using a comment after the code on a line.
USE AdventureWorks;
GO
UPDATE Production.Product
SET ListPrice = ListPrice * .9; -- Reduce price to build market share.
GO