概要:このチュートリアルでは、MySQLコメントを使用してSQLステートメントまたはMySQLのコードブロックを文書化する方法を学習します。
コメントを使用して次の目的を文書化できます。 SQLステートメントまたはストアドプロシージャ内のコードブロックのロジック。 SQLコードを解析するとき、MySQLはコメント部分を無視します。次のセクションで説明する実行可能コメントを除いて、SQL部分のみを実行します。
MySQLは3つのコメントスタイルをサポートします。
- を行末まで。二重ダッシュコメントスタイルでは、2番目のダッシュの後に少なくとも空白または制御文字(スペース、タブ、改行など)が必要です。
SELECT * FROM users; -- This is a comment
標準SQLでは2番目のダッシュの後の空白。 MySQLは空白を使用して、次のようなSQL構造の問題を回避します。
SELECT 10--1;
ステートメントは11を返します。MySQLが空白を使用しなかった場合は、空白を使用します。代わりに10を返します。
-
"#"
から行末まで。SELECT lastName, firstNameFROM employeesWHERE reportsTo = 1002; # get subordinates of Diane
- Cスタイルのコメント
/**/
は複数行にまたがることができます。このコメントスタイルを使用して、SQLコードのブロックを文書化します。/* Get sales rep employees that reports to Anthony*/SELECT lastName, firstNameFROM employeesWHERE reportsTo = 1143 AND jobTitle = "Sales Rep";
MySQLはネストされたコメントをサポートしていないことに注意してください。
実行可能コメント
MySQLは、異なるデータベース間の移植性をサポートするための実行可能コメントを提供します。これらのコメントを使用すると、MySQLでのみ実行され、他のデータベースでは実行されないSQLコードを埋め込むことができます。
実行可能なコメント構文を次に示します。
Code language: SQL (Structured Query Language) (sql)
たとえば、次のステートメントは実行可能コメントを使用します。
Code language: SQL (Structured Query Language) (sql)
ステートメントは1ではなく2を返します。ただし、実行すると1が返されます。他のデータベースシステムで使用します。
特定のバージョンのMySQLからコメントを実行する場合は、次の構文を使用します。
Code language: SQL (Structured Query Language) (sql)