コメント

コメントは、プログラム コード内にある実行対象外のテキスト文字列です。注釈とも呼ばれます。コメントは、コードを説明したり、診断中の Transact-SQL ステートメントやバッチを部分的に一時無効にするのに使用します。コメントを使用してコードを説明すると、後でプログラム コードのメンテナンス作業が容易になります。コメントは、プログラム名、作成者名、およびコードを大幅に変更した日付を記録する場合にも使用します。複雑な計算の記述やプログラミング方法の説明にも使用できます。

SQL Server では、次の 2 種類のコメント文字がサポートされています。

  • -- (二重ハイフン)。実行コードと同じ行にコメントを記述できるだけでなく、コメント専用の行にすることもできます。二重ハイフンの後ろから行末までがコメント部分になります。複数行にわたってコメントを記述する場合、すべてのコメント行の先頭に二重ハイフンを入力する必要があります。コメント文字の使用方法の詳細については、「-- (コメント) (Transact-SQL)」を参照してください。

  • /* ... /* ... */ (スラッシュとアスタリスクの組み合わせ)。実行コードと同じ行にコメントを記述できるだけでなく、コメント専用の行にすることもできます。また、実行可能コード内でも使用することができます。コメント開始記号 (/*) とコメント終了記号 (*/) で囲まれた部分がコメントと見なされます。複数行にわたってコメントを記述する場合、コメントの先頭にコメント開始記号 (/*) を入力し、コメントの最後にコメント終了記号 (*/) を入力する必要があります。コメント文字の使用方法の詳細については、「/*...*/ (コメント) (Transact-SQL)」を参照してください。

考慮事項

次にコメントについての基本的な注意事項を示します。

  • コメントではすべての英数字と記号を使用できます。SQL Server は、コメント内のすべての文字を無視してコードを実行します。ただし、SQL Server Management Studio コード エディターおよび sqlcmd は、複数行のコメント内に、先頭の 2 文字が "GO" になっている行がないか探します。

  • バッチ内のコメント長には制限がありません。コメントは、複数行にわたって記述することができます。

次に、いくつかの有効なコメントの例を示します。

USE AdventureWorks2008R2;
GO
-- Single line comment.

SELECT BusinessEntityID, 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 BusinessEntityID, /* FirstName, */ LastName
FROM Person.Person;

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