MySQLでコメントをする方法！コメント方法3パターン！

MySQLでSQLにコメントを書く方法について書いています。
MySQLでコメントを書く方法として、下記の3つのパターンがあります。

コメントについては、公式のこちらのページに書いています。
載せているSQLについては、MySQLのバージョン8.0.32を使って動作を確認しています。

MySQLでコメントをする方法

MySQLのコメントはプログラムのコメントと同じで、実行される処理に関わらず説明を書いておくことができます。
コメントする方法が3つあるので、見ていきましょう。

「#」で行末までコメント

「#」を使うことで、書いたところから行末までコメントを入れることができます。
下記SQLのようにコメントすることが可能です。

# 果物データを入れるテーブル
CREATE TABLE fruits (
  id BIGINT NOT NULL AUTO_INCREMENT, # ID
  name VARCHAR(256), # 名前
  price INT, # 価格
  PRIMARY KEY (id)
);

このように「#」で行の先頭からコメントにすることができます。
また、行の途中から「#」を書いたときには、その後の文字列がコメントになります。

「--」で行末までコメント

「--」を使うことでも、書いたところから行末までコメントできます。
下記SQLのようにコメントすることが可能です。

-- 果物データを入れるテーブル
CREATE TABLE fruits (
  id BIGINT NOT NULL AUTO_INCREMENT, -- ID
  name VARCHAR(256), -- 名前
  price INT, -- 価格
  PRIMARY KEY (id)
);

先ほどと同じように「--」でもコメントできました。

「#」と同じように行頭から使うと、行末までコメントされます。
行の途中から使うと、その後の文字列がコメントになりました。

「/*」と「*/」でコメント

「/*」を書いてコメントを始めて、「*/」を書くとコメントが終わります。
この書き方は改行に対応していて、複数行のコメントを入れるときには便利です。

例えば、下記のようにコメントすることができます。

/*---
  果物データを入れるテーブル
  カラム:id/name/price
---*/
CREATE TABLE fruits (
  id BIGINT NOT NULL AUTO_INCREMENT, /* ID */
  name VARCHAR(256), /* 名前 */
  price INT, /* 価格 */
  PRIMARY KEY (id)
);

先頭から「/*」を書いて、コメントしています。
この書き方だと、改行もコメントになります。最後に「*/」を書いたところまでがコメントになります。

1行でコメントする時も、上記のように「/* コメント */」でコメントを書くことができます。

MySQLでコメントをする方法まとめ

今回はMySQLでコメントをする方法をまとめました。
記事の内容をまとめると、下記のようになります。

基本的には「#」か「--」でコメントを書いて、複数行で書くときには「/* コメント */」を使うと良いかと思います。