Использование ASDoc с Bindable metatag и mxml - PullRequest
2 голосов
/ 31 августа 2009

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

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

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

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

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

Ответы [ 2 ]

1 голос
/ 13 октября 2009

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

0 голосов
/ 31 августа 2009

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

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

...