MySQL コメント
この記事では、MySQL コメントを紹介します。また、どこでどのような種類のコメントを使用する必要があるかについても学習します。
コメントは、コードをわかりやすく説明するために書かれています。また、コメントを使用して、SQL クエリの解析中にコードの特定の部分を無視します（そのコードを実行させないでください）。
また、他のプログラマーがコードで何が起こっているのかを理解するのにも役立ちます。MySQL で 1 行コメントと複数行コメントを使用する方法を説明します。また、実行可能なコメントとその使用法についても見ていきます。
MySQL コメントを書くには 3つの異なる方法があります。コメントには、#、-、または/*と*/の記号を使用できます。
MySQL 単一行コメント
MySQL の単一行コメントは、# または - を使用する 2つの方法で使用できます。
MySQL コメントを練習するために tb_teachers という名前のテーブルを作成しましょう。# を使用して、以下に示す MySQL クエリに 1 行のコメントを書き込みます。
このコメントは SQL クエリの最後に使用され、その後に改行を入れる必要があります。コメントの後に改行を使用しない場合、同じ行にあるすべてのものは、改行が発生するまでコメント化されます。# の後に空白を入れる必要はありません。ただし、読みやすさを向上させるために、# の後に空白を付けることをお勧めします。
# を使用した MySQL サンプルコード：
# Following SQL query will create a table named 'tb_teachers'
CREATE TABLE `practice_mysql_comments`.`tb_teachers` (
TEACHER_ID INTEGER NOT NULL,
FIRST_NAME VARCHAR(30) NOT NULL,
LAST_NAME VARCHAR(30) NOT NULL,
GENDER VARCHAR(30) NOT NULL,
CITY VARCHAR(64) NOT NULL,
EMAIL VARCHAR(64) NOT NULL,
JOINING_YEAR INTEGER NOT NULL,
PRIMARY KEY (TEACHER_ID)
);
1 行コメントを使用した後に改行を入れない次のコード例を参照してください。CREATE コマンドも部分的にコメント化されていることがわかります。
# Following SQL query will create a table named 'tb_teachers' CREATE TABLE `practice_mysql_comments`.`tb_teachers` (
TEACHER_ID INTEGER NOT NULL,
FIRST_NAME VARCHAR(30) NOT NULL,
LAST_NAME VARCHAR(30) NOT NULL,
GENDER VARCHAR(30) NOT NULL,
CITY VARCHAR(64) NOT NULL,
EMAIL VARCHAR(64) NOT NULL,
JOINING_YEAR INTEGER NOT NULL,
PRIMARY KEY (TEACHER_ID)
);
このタイプのコメントは、SQL クエリ内でも使用できます。次のコードを参照してください。# を使用して SQL クエリ内でコメントできることがわかります。
# Following SQL query will create a table named 'tb_teachers'
CREATE TABLE `practice_mysql_comments`.`tb_teachers` (
TEACHER_ID INTEGER NOT NULL, # teacher's id
FIRST_NAME VARCHAR(30) NOT NULL, # teacher's first name
LAST_NAME VARCHAR(30) NOT NULL, # teacher's last name
GENDER VARCHAR(30) NOT NULL, # teacher's gender
CITY VARCHAR(64) NOT NULL, # teacher's home town
EMAIL VARCHAR(64) NOT NULL, # teacher's email
JOINING_YEAR INTEGER NOT NULL, # teacher's appointment year
PRIMARY KEY (TEACHER_ID) # primay key of the teacher's table
);
- 記号を使用して、1 行のコメントの別の方法を調べてみましょう。次の SQL コードは、SQL クエリ内でもコメントに二重の -（ダッシュ）記号を使用できることを示しています。
# 記号を使用してコメントするのと同じですが、違いは 1つだけです。2 番目のダッシュの後に少なくとも 1つの空白を入れる必要があります。それ以外の場合は、コメントとして機能しません。
-- Following SQL query will create a table named 'tb_students'
CREATE TABLE `practice_mysql_comments`.`tb_students` (
STUDENT_ID INTEGER NOT NULL, -- student's id
FIRST_NAME VARCHAR(30) NOT NULL, -- student's first name
LAST_NAME VARCHAR(30) NOT NULL, -- student;s last name
GENDER VARCHAR(30) NOT NULL, -- student's gender
CITY VARCHAR(64) NOT NULL, -- student's home town
EMAIL VARCHAR(64) NOT NULL, -- student's email
REGISTRATION_YEAR INTEGER NOT NULL, -- student's registration year
PRIMARY KEY (STUDENT_ID) -- primay key of the student's table
);
MySQL マルチラインコメント
コードを理解しやすくするために SQL クエリを詳細に説明する必要がある場合は、複数行のコメントを使用します。/* */内のすべてが無視されます。このタイプのコメントの最後に改行を入れるかどうかは関係ありませんが、クリーンで整理されたコードを書くために改行を入れるのは良いことです。
/*
Following SQL query will create a table named 'tb_students'
having the basic information about the students. This information includes
full name, gender, city, email and registration year.
*/
CREATE TABLE `practice_mysql_comments`.`tb_students` (
STUDENT_ID INTEGER NOT NULL,
FIRST_NAME VARCHAR(30) NOT NULL,
LAST_NAME VARCHAR(30) NOT NULL,
GENDER VARCHAR(30) NOT NULL,
CITY VARCHAR(64) NOT NULL,
EMAIL VARCHAR(64) NOT NULL,
REGISTRATION_YEAR INTEGER NOT NULL,
PRIMARY KEY (STUDENT_ID)
);
複数行のコメントを 1 行として扱うことはできますが、1 行のコメントがある場合に労力を増やすのはなぜですか。複数行を実行したくない場合は、複数行のコメントを使用することをお勧めします。次の例を参照してください。
/*
Following SQL query will create a table named 'tb_students'
having the basic information about the students. This information includes
full name, gender, city, email and registration year.
*/
CREATE TABLE `practice_mysql_comments`.`tb_students` (
STUDENT_ID INTEGER NOT NULL,
FIRST_NAME VARCHAR(30) NOT NULL,
LAST_NAME VARCHAR(30) NOT NULL,
GENDER VARCHAR(30) NOT NULL,
CITY VARCHAR(64) NOT NULL,
/* EMAIL VARCHAR(64) NOT NULL,
REGISTRATION_YEAR INTEGER NOT NULL, */
PRIMARY KEY (STUDENT_ID)
);
MySQL 実行可能コメント
MySQL は実行可能コメントもサポートしています。このタイプのコメントは、さまざまなデータベース間の移植性を提供します。これらのコメント内に記述されたコードは、MySQL でのみ実行されます。!の後にバージョンを指定した場合文字の場合、その特定の MySQL バージョン以上でのみ機能します。
実行可能コメントのサンプルコード：
SELECT 3 /*! *2 */ AS MULTIPLICATION;
まとめ
MySQL のコメントは、プログラミング中に重要な役割を果たすと結論付けました。プログラミングの種類は関係ありません。複数行を無視する必要がある場合は、複数行コメントを使用することをお勧めします。それ以外の場合は、1 行のコメントで問題ありません。特定のコードを MySQL サーバーでのみ実行する場合は、MySQL 実行可能コメントを使用できます。
