Документирование AS3 кода
Привет. Давненько я что-то ничего не писал...)
Столкнулся здесь с проблемой построения документации по Flex-проекту. Первое, к чему обратился, был ASDoc от Adobe. Может быть, у меня очень кривые руки или еше что:), но построить доку с помощью тулзы от Adobe я так и не смог в том варианте, каком хотелось бы. Куча ошибок сразу вылезает, вылезают dependencies, которые лезут документировать "родной" flex-код. Почему-то параметр exclude-dependencies не помогает... На сайте labs.adobe.com приведен список багов, которые тоже не радуют... В общем я немного потыкался, и желание использовать такой tool пока отпало. Зашел на osflash.org, а там:
ZenDoc, очень простая тулза, написанная на php (с UI-интерфейсом), без поддержки пакетной документации (пока, но вроде обещают) и документации mxml. Работает на Apache (как построение доки, так и просмотр, что не очень удобно). В общем очень простенький инструмент, который сразу заработал. Но, конечно, отсутствие пакетной документации пока серьезный минус.
NaturalDocs - вещь:)! Написан на perl - command line (соответственно, для работы нужен Perl). Но весь мой проект (и as и mxml) обработал сразу - никаких ошибок. Все пакетно, с построением иерархий и т.д. Правда, формат NaturalDocs не очень привычен, но, думаю, там что-то можно еще настроить, чтобы жизнь с этим инструментом стала лучше. Также стоит отметить, что NaturalDocs работает еще с кучей языков, помимо AS3 и AS2.
В общем, пока мне больше всех понравился NaturalDocs. Самое главное, простой в использовании.
Столкнулся здесь с проблемой построения документации по Flex-проекту. Первое, к чему обратился, был ASDoc от Adobe. Может быть, у меня очень кривые руки или еше что:), но построить доку с помощью тулзы от Adobe я так и не смог в том варианте, каком хотелось бы. Куча ошибок сразу вылезает, вылезают dependencies, которые лезут документировать "родной" flex-код. Почему-то параметр exclude-dependencies не помогает... На сайте labs.adobe.com приведен список багов, которые тоже не радуют... В общем я немного потыкался, и желание использовать такой tool пока отпало. Зашел на osflash.org, а там:
- ZenDoc, которые как раз обновились для AS3
- NaturalDocs, которые тоже недавно включили поддержку AS3
ZenDoc, очень простая тулза, написанная на php (с UI-интерфейсом), без поддержки пакетной документации (пока, но вроде обещают) и документации mxml. Работает на Apache (как построение доки, так и просмотр, что не очень удобно). В общем очень простенький инструмент, который сразу заработал. Но, конечно, отсутствие пакетной документации пока серьезный минус.
NaturalDocs - вещь:)! Написан на perl - command line (соответственно, для работы нужен Perl). Но весь мой проект (и as и mxml) обработал сразу - никаких ошибок. Все пакетно, с построением иерархий и т.д. Правда, формат NaturalDocs не очень привычен, но, думаю, там что-то можно еще настроить, чтобы жизнь с этим инструментом стала лучше. Также стоит отметить, что NaturalDocs работает еще с кучей языков, помимо AS3 и AS2.
В общем, пока мне больше всех понравился NaturalDocs. Самое главное, простой в использовании.