Игры, математика, программирование, и просто размышлизмы

воскресенье, 25 сентября 2011 г.

RealDocs для ActionScript 3.0

Редко, но все- же иногда возникает необходимость генерировать документацию по ActonScript 3.0 коду.

Если с Java в этом деле всё обстоит неплохо, с ActionScript 3.0 есть трудности: asdoc перед проверкой осуществляет синтаксический анализ кода и если находит ошибки, документации не генерирует. На практике, это означает, что при генерации кода нужно прописывать пути ко всем либам. Для флекса это ещё туда – сюда, но с флешом дело плохо. Во первых, если я хочу создать мувиклип, не создавая ассоциированный с ним файл, сделать это не удастся. Во вторых есть либы, которые вставляются в flash CS как плагин. Короче, без танцев с бубном сгенерировать не удастся.

Да и вообще, сам подход неприличен: я должен сам указывать инструменту, что мне делать, а не он мне указывать, как быть. Вот не хочу я ещё раз проверять код - я уже проверил его другими средствами, уже скомпилировал. Зачем мне ещё какой - то asdoc?

Благо, есть другие средства, например NaturalDocs, расположенный по адресу http://naturaldocs.org, там же ссылки на скачивание с соурсфоржа. Кроме экшенскрипта, данное средство поддерживает C/C++, Java, PHP, Python, PL/SQL, Visual Basic, Pascal/Delphi, Ada, JavaScript, Ruby, Tcl, ColdFusion, Assembly, Fortran (free-format only), R, Makefiles, Plain Text

Он написан на перле, в качестве интерпретатора для винды предлагается скачать Active Perl. Вот его сайт: http://www.activestate.com/activeperl

Далее, качаем RealDocs и распаковываем его. Идем в папку, куда разархивировали RealDocs и правим предпоследнюю строчку так, чтобы получилось нечто вроде.

C:\Perl\bin\perl D:\install_windows\NaturalDocs\NaturalDocs %NaturalDocsParams%

Обратите внимание, что вместо wperl.exe в исходном файле написано perl. И путь к perl скрипту тоже абсолютный, вместо относительного.

Далее, создаем скрипт для генерации, примерно такой

d:\install_windows\NaturalDocs\NaturalDocs -i d:\projects\hello -o html d:\outputdocs -p d:\naturaldocsproject

Здесь d:\install_windows\NaturalDocs\NaturalDocs – путь к соответствующему скрипту

Ключи знают следующее:

-i Путь к сырцам

-o Тип документа, который будем генерировать и путь к папке, куда складывать доки

- p путь к файлу проекта, куда складывают логи

Запускаем батник – получаем результат. Все!

Конференция на Ciklum Game Developers Saturday

На этой конференции я рассказывал о принципах создания изометрических движков
Презентацию можно посмотреть здесь