Использование ASDoc с привязываемым метатегом и mxml

Я создаю документацию своего гибкого проекта с помощью 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. Но гибкие документы говорят, что если u укажите имя события с помощью тега Bindable, затем «вы несете ответственность за создание и отправку события». Мой проект почти завершен, и я полагался на привязку (без имен событий) во многих местах, что делало непрактичным возвращаться и все менять - это потребует больших усилий; плюс идея испортить рабочий код для создания документации кажется мне пугающей.

Замена всех экземпляров [Bindable] на [Bindable("blah")] перед созданием asdoc с последующим их изменением - единственный обходной путь, который я могу придумать. Но я чувствую, что должен быть способ получше.

трекер ошибок Adobe утверждает, что проблема с общедоступными переменными была исправлена ​​в последней версии build, поэтому я загрузил последнюю версию flex sdk (3.4) и попробовал использовать прилагаемый к нему ASDoc, но он дал мне тот же результат.

Может ли кто-нибудь пролить свет на эту проблему?

Кроме того, в в блоге Adobe говорится, что ASDoc теперь также поддерживает mxml, но когда я попробовал с последней (flex 3.4) ASDoc, мои комментарии mxml asdoc (встроенные в) не отображались на странице html, которая была сгенерирована. кто-нибудь знает, доступна ли последняя версия asdoc для загрузки отдельно?


person Amarghosh    schedule 31.08.2009    source источник


Ответы (2)


Хотя я не могу помочь вам с обходным путем, проблема в том, что [Bindable] (без имени события) генерирует код оболочки (я считаю, что это отдельное свойство) вокруг свойства. Этот код явно не работает с asdoc.

person Richard Szalay    schedule 13.10.2009

Вы не предоставляете номера Jira для проверки, но ...

Изменения ASDoc для MXML есть только во Flex 4 (IIRC), я бы проверил, что ошибка привязки не та.

person Gregor Kiddie    schedule 31.08.2009