Использование ASDoc с Bindable metatag и mxml
Я создаю документацию по моему проекту Flex, используя ASDoc, и имею некоторые проблемы с привязываемым метатегом.
- ASDoc не документирует
public Bindable
значения, если с тегом Bindable не связано имя события.
Например:
//This is documented correctly
[Bindable("someEvent")]
/*
* public bindable with event name
* */
public var test1:String;
//This is not documented at all
[Bindable]
/*
* public bindable without event name
* */
public var test2:String;
- ASDoc добавляет случайные строки к именам
protected Bindable
значения, если с привязываемым тегом не связано имя события.
Например:
//This is documented correctly as test3
[Bindable("someEvent")]
/*
* protected bindable with event name
* */
protected var test3:String;
//But this is documented as _110251490test4
[Bindable]
/*
* protected bindable without event name
* */
protected var test4:String;
Подводя итог, ASDoc не доволен Bindable
теги без имени события. Кажется, что простым решением было бы указать имя события всякий раз, когда вы объявляете что-то как Bindable. Но в гибких документах сказано, что если вы укажете имя события с помощью тега Bindable, то "вы несете ответственность за генерацию и отправку события". Мой проект почти завершен, и я полагался на связывание (без названий событий) во многих местах, что делает нецелесообразным возвращаться и изменять все - для этого потребуется много усилий; плюс идея испортить рабочий код для создания документации звучит мне страшно.
Замена всего [Bindable]
случаи с [Bindable("blah")]
прежде чем генерировать asdoc и затем изменять их обратно, я могу придумать только один способ. Но я чувствую, что должен быть лучший путь.
Adobe отслеживания ошибок утверждает, что проблема с общедоступными переменными была исправлена в последней сборке, поэтому я скачал последнюю версию Flex SDK (3.4) и попробовал с ASDoc, который поставляется с ним - но он дал мне тот же результат.
Кто-нибудь может пролить свет на этот вопрос?
Кроме того, в блоге Adobe говорится, что ASDoc теперь также поддерживает mxml, но когда я попробовал использовать новейший (flex 3.4) ASDoc, мои комментарии mxml asdoc (встроенные в) не появились на созданной html-странице. Кто-нибудь знает, если последний Asdoc доступен для загрузки отдельно?
2 ответа
Хотя я не могу помочь вам с обходным решением, проблема в том, что [Bindable] (без имени события) генерирует код обертки (я считаю, отдельным свойством) вокруг свойства. Этот код явно возиться с asdoc.
Вы не предоставляете номера Jira для проверки, но...
Изменения ASDoc для MXML внесены только во Flex 4 (IIRC), я бы сказал, что ошибка привязки не та же.