Как написать комментарий для элемента, который я определил в flex?

Question

Я хочу добавить комментарий к некоторым элементам в документе Flex и обработать комментарии с помощью ASDoc.Я легко могу сделать это для части скрипта, но в итоге получаю массу уродливых «Это свойство может использоваться как источник для привязки данных».сообщения для каждого элемента, который я объявил во Flex.

Есть ли способ вставить комментарий в элемент flex, чтобы он мог быть прочитан ASDoc?Я пытался использовать стандартную нотацию

<!-- --> 

, но это не помогло.

РЕДАКТИРОВАТЬ: запись, как представляется, поглощены как комментарий HTML, я полагаю, вы знаете, как это выглядит ...

Answer 1

Не видя ваш код, довольно сложно точно сказать, что происходит. Ничто в ASdocs не должно вызывать ошибку компиляции, которую можно связать. Вы получаете эту ошибку от компилятора Flex или компилятора ASDoc? Вы пытаетесь задокументировать документ MXML или документ ActionScript?

Вы читали эти документы?

Вкл. ActionScript :

/**
* Your Comment Goes Here
*/
ActionScript Element

А на MXML ? Комментарии MXML ASDoc должны содержать три черты, а не 2 для первого маркера комментария. Как это:

<!--- Your comment goes here -->
MXML Element

Answer 2

Вы пытаетесь разместить комментарии в разметке?

В соответствии с документацией Flex здесь : «Поскольку формат комментария ASDoc использует синтаксис ActionScript, вы можете вставить комментарий ASDoc только в блок файла MXML.»

Answer 3

Вы можете использовать эти // и / * * / (внутри блоков ActionScript) Чтобы закомментировать узел MXML, используйте <!-- and end with -->