Комментарии (синтаксис MDX)

Комментарии — это неисполняемые текстовые строки в программном коде. (Комментарии также называются замечаниями). Вы можете использовать комментарии для документирования кода или временно отключать части операторов многомерных выражений (MDX) и скриптов, которые диагностируются. Используя комментарии для документирования кода, вы сможете упростить поддержку программного кода в будущем. Вы часто используете комментарии для записи названия программы, автора и дат крупных изменений кода. Вы также можете использовать комментарии для описания сложных вычислений или объяснения метода программирования.

Комментарии в MDX следуют следующим рекомендациям:

  • В комментарии можно использовать все буквенно-цифровые символы или символы. Все персонажи в комментариях игнорируются.

  • В утверждении или сценарии нет максимальной длины для комментария. Комментарий может состоять из одной или нескольких строк.

MDX поддерживает три типа комментирующих персонажей:

(двойной удар вперёд)
Эти символы комментариев могут использоваться в той же строке, что и код, который нужно выполнить, или в отдельной строке. Всё — от двойных вперёд до конца линии — часть комментария. Для многострочного комментария двойные прямые черты должны отображаться в начале каждой строки. Для получения дополнительной информации см. (Комментарий) (MDX).

-- (двойные дефисы)
Эти символы комментариев могут использоваться в той же строке, что и код, который нужно выполнить, или в отдельной строке. Всё — от двойных дефисов до конца строки — часть комментария. Для многострочного комментария двойные дефисы должны отображаться в начале каждой строки. Для получения дополнительной информации см. -- (Комментарий) (MDX).

/* ... */ (пары символов вперёд — звёздочка)
Эти символы комментариев могут использоваться в той же строке, что и код, выполняемый для запуска, по отдельной строке или даже внутри исполняемого кода. Всё — от пары открытых комментариев (/*) до пары закрытых комментариев (*/) считается частью комментария. Для комментария с несколькими строками пара символов открытого комментария (/*) должна начать комментарий, а пара символов близкого комментария (*/) должна завершить комментарий. Ни один другой персонаж комментариев не может появляться ни в одной строке комментария. Для получения дополнительной информации см. /*...*/ (Комментарий).

Пример

Следующий запрос показывает примеры всех трёх типов комментариев:

//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]