コードの読みやすさを向上させるために、MaxCompute SQLスクリプトにコメントを書くことができます。 このトピックでは、MaxCompute SQLスクリプトで単一行および複数行のコメントを使用する方法について説明します。
制限事項
複数行のコメント機能は、DataWorksデータ開発インターフェイスでは使用できません。
MaxComputeのローカルクライアント (odpscmd) でSQLコメントを使用するには、odpscmdのバージョンが0.49.0以降である必要があります。
MaxComputeクライアント (odpscmd) またはCloud Shell (odpscmd) で1行のコメントを使用する場合、コメントを終了するにはセミコロン (;) が必要です。 セミコロンは複数行のコメントではサポートされていません。
構文形式
単一行コメント
-- で単一行のコメントを開始します。 構文は次のとおりです。
-- Comment content-から行の末尾までのテキストはコメントとして扱われます。 コメントは、コードの上の別の行またはコード行の末尾に配置できます。
MaxComputeコンソールのSQL分析インターフェイスまたはDataWorksデータ開発インターフェイスで、Ctrl +/ ショートカットを使用してコード行をコメントアウトできます。
複数行のコメント
複数行のコメントの場合、/* を使用して開始し、*/ を使用して終了すると、コンテンツのブロックを一度にコメントアウトできます。 構文は次のとおりです。
/*
Comment
content
*/MaxComputeは、MAPJOINヒントやSKEWJOINヒントなどのヒント構文として /* +...*/ もサポートしています。 ヒントは複数行のコメントよりも優先されるため、複数行のコメントの開始シンボルがヒントの開始シンボルと間違えられないようにします。 混乱を避けるため、複数行のコメントの開始記号として /** を使用することを推奨します。
使用例
my_tableを既存のテーブルと見なします。 次のコードはコメントの例を示しています。
例1: 正しい単一行のコメント。
-- Single-line comment DESC my_table; -- Single-line comment例2: 正しい複数行のコメント。
SELECT /* Valid multi-line comment */ * FROM my_table;例3:
/* +がヒントの先頭として誤って解釈されている、誤った複数行のコメント。SELECT /*+ Invalid multi-line comment */ * FROM my_table;