SQL Serverでコメント（注釈）を活用する方法

本記事では、SQL Serverのステートメントでコメント（注釈）を使用する方法について詳しく解説します。

コメントとは

SQL Serverでは、ステートメントの横にコメントを記述することができます。コメントは、コードの説明やメモ、補足情報を残すために活用され、作業画面上で1行または複数行にわたって自由に記述できます。

コメントの基本構文

SQL文にコメントを作成するには、主に次の2つの構文があります。

「--」記号を使用する方法

使い方は以下の通りです。

-- コメントをここに記述

SQL Serverでは、「--」記号で始まるコメントはステートメントの末尾に配置し、コメントの終了後には必ず改行が必要です。

「/*」と「*/」記号を使用する方法

使い方は以下の通りです。

/* コメントをここに記述 */

SQL Serverでは、「/*」で始まり「*/」で終わるコメントは、SQLステートメント内の任意の場所に使用できます。また、この形式のコメントは複数行にわたって記述することも可能です。

1行コメントの記述例

1行コメントはさまざまな位置に記述できます。コマンドの途中やステートメントの末尾、あるいは独立した1行としても記述可能です。具体的な例を見ていきましょう。

コマンドの途中にコメントを記述する場合：

SELECT /* 作成者: quantrimang.com */ employee_id, last_name
FROM employees;

コマンドの末尾にコメントを記述する場合：

SELECT employee_id, last_name /* 作成者: quantrimang.com */
FROM employees;

または、次のように「--」を使っても記述できます。

SELECT employee_id, last_name -- 作成者: quantrimang.com
FROM employees;

コメントを独立した行に記述する場合：

SELECT employee_id, last_name
/* 作成者: quantrimang.com */
FROM employees;

複数行コメントの記述例

SQL Serverでは、SQLステートメントの中で複数行にわたってコメントを記述することもできます。以下に例を示します。

SELECT employee_id, last_name
/*
* 作成者: quantrimang.com
* 目的: SQLステートメント内で複数行にわたるコメントを表示する
*/
FROM employees;

この例では、コメントが作業画面上の4行にわたって記述されています。

また、次のような構文を使用することもできます。

SELECT employee_id, last_name /* 作成者: quantrimang.com
目的: SQLステートメント内で複数行にわたるコメントを表示する。 */
FROM employees;

ステートメントの横にコメントを適切に記述しておくことで、コードの理解や管理が容易になり、エラーの特定や修正も迅速かつ効率的に行えるようになります。チーム開発においても、他のメンバーがコードの意図を把握しやすくなるため、可読性の高いSQLを書くうえでコメントの活用は非常に重要です。

それでは、快適なSQLライフをお過ごしください！