コメント (MDX 構文)
コメントは、プログラム コードで実行されていないテキスト文字列です。 (コメントは "注釈" とも呼ばれます)。 コメントを使用してコードを文書化したり、診断対象の多次元式 (MDX) ステートメントとスクリプトの一部を一時的に無効にしたりできます。 コメントを使用してコードを文書化することで、将来のプログラム コードのメンテナンスを容易にすることができます。 また、プログラム名、作成者名、およびコードの主要な変更日を記録するためにコメントを使用する場合も少なくありません。 また、コメントを使用して複雑な計算を記述したり、プログラミング方法を説明したりすることもできます。
MDX のコメントは、次のガイドラインに従います。
コメント内では、すべての英数字または記号を使用できます。 コメント内のすべての文字は無視されます。
ステートメント内またはスクリプト内のコメント長には制限がありません。 コメントは 1 行以上で構成できます。
MDX では、次の 3 種類のコメント文字がサポートされています。
// (二重スラッシュ)
これらのコメント文字は、実行するコードと同じ行、または単独で 1 行で使用できます。 二重スラッシュから行末までのすべてがコメントの一部です。 複数行のコメントの場合は、各コメント行の先頭に二重スラッシュを指定する必要があります。 詳細については、「 (コメント) (MDX)」を参照してください。
-- (二重ハイフン)
これらのコメント文字は、実行するコードと同じ行、または単独で 1 行で使用できます。 二重ハイフンから行末まではすべてコメントの一部です。 複数行にわたってコメントを記述する場合、それぞれのコメント行の先頭に二重ハイフンを入力する必要があります。 詳細については、「 -- (コメント) (MDX)」を参照してください。
/* ... */ (スラッシュとアスタリスクの文字ペア)
このコメント文字では、実行コードと同じ行にコメントを記述できるほか、コメント専用の行にすることもできます。さらに、実行可能コード内でもこのコメント文字を使用できます。 開いているコメント ペア (/*) から閉じるコメント ペア (*/) まではすべて、コメントの一部と見なされます。 複数行のコメントの場合は、コメントを開始するオープンコメント文字ペア (/*) を指定し、コメントを閉じる文字ペア (*/) でコメントを終了する必要があります。 コメントの行に他のコメント文字を表示することはできません。 詳細については、「 /*...*/ (コメント)」を参照してください。
例
次のクエリは、3 種類のすべてのコメントの例を示しています。
//An example of a comment using the double-forward slash
--An example of a comment using the double-hyphen
/*An example of a
multi-line
comment*/
SELECT
{[Measures].[Internet Sales Amount]} ON Columns,
[Date].[Calendar].MEMBERS ON Rows
FROM [Adventure Works]