PDA

Просмотр полной версии : как создать батник который будет asdoc-ить весь проект?


Vitalya
03.02.2012, 12:29
есть директория в которой куча папок и as-ок, нужно создать батник который будет создавать из всех as-ок, документацию.

toFL
03.02.2012, 13:29
1) Для документации существует соответствующий формат:

/** Документация */
public function myFunc () {};

2) Подробное описание -> тут (http://help.adobe.com/en_US/flex/using/WSd0ded3821e0d52fe1e63e3d11c2f44bb7b-7fe7.html).
3) Графическая оболочка для ASDOC -> тут (http://flash-ripper.com/archives/002376.php).
4) Вариант компиляции ANT-ом -> тут (http://www.herrodius.com/blog/85) и тут (http://www.unitedmindset.com/jonbcampos/2010/01/28/building-asdocs-with-ant/).

О великий и могучий google (http://google.ru).

Dukobpa3
03.02.2012, 14:34
Флешдевелоп умеет это делать одной кнопкой.
Правда муторное это дело. Там требования к оформлению кода покруче чем при компиляции. Если проект нормально компилится и запускается - еще не значит что тулза захочет этот код документировать без рефактора:)
Но не так страшен черт как его малюют)

Добавлено через 41 секунду
Да и флешбилдер вроде как тоже, но им не пробовал.

dsQuadro
03.02.2012, 14:56
Флешдевелоп умеет это делать одной кнопкой а поподробнее можно? где найти эту чудо кнопочку?

Jewelz
03.02.2012, 14:59
в тулзах

Dukobpa3
03.02.2012, 15:12
Tools->Flash tools->Documentation generator

Там разобраться в принципе не сложно, но помню я когда первый раз делал то гуглил что-то. В итоге всё получилось, но пришлось немного рефактора провести ибо тулза капризная очень. Она твой проект пытается типа скомпилить да еще и анализ валидности провести, если слишком много варнингов то пошлет.

Vitalya
07.02.2012, 02:15
1. Установить JRE
2. Открыть командную строку
2.1 Перейти в каталог C:\Program Files\Adobe\Adobe Flash Builder 4.6\sdks\4.6.0\bin c помощью команды "cd"
Пример
"c:\>cd C:\Program Files\Adobe\Adobe Flash Builder 4.6\sdks\4.6.0\bin"
2.2 Проверим работоспособность ASDoc, командой "asdoc"
Пример
"C:\Program Files\Adobe\Adobe Flash Builder 4.6\sdks\4.6.0\bin>asdoc"
! После этого появится сообщение либо об ошибки либо о готовности
3. Если в проекте есть библиотеки содержащие SWC - файлы, подключаем их командой - -library-path
Пример:
-library-path+=d:\BOOLAT\boolatsoc\trunk\GameMachine\libs\
-library-path+=d:\BOOLAT\boolatsoc\trunk\GameMachine\assets\
-library-path+=d:\BOOLAT\boolatsoc\trunk\GameMachine\assets_src\
-library-path+=d:\BOOLAT\boolatsoc\trunk\GameMachine\src\crash\
4. После чего подключаем документируемые классы с помощью команды - -doc-classes
Пример:
-doc-classes com.boolat.events.UIEvent com.boolat.events.TryToRemoveEvent

!!! При документировании основные ошибки такие:
1. "<" - &lt;, ">" - &gt;
2. не закрыт тег <B> + </B>
3. Ошибки кода
4. Ссылки на несуществующие классы

dsQuadro
07.02.2012, 18:24
Tools->Flash tools->Documentation generator


Благодарю! ругается конечно на многое что компилятор пропускает =)

Vitalya
12.02.2012, 19:31
Народ как отключить проверки эти??