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

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

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

<!-- -->

нотации, но это не сработало.

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

Источник

3 ответа

Решение

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

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

Источник

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

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

На ActionScript:

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

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

<!--- Your comment goes here -->
MXML Element
Источник

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

Источник
Другие вопросы по тегам