Блог от AS3Coder'a о JavaScript, HTML, CSS... и немного о Flash.

среда, 7 июля 2010 г.

ASDoc. Сборка справки во FlashDevelop.

Часто ли с вашим кодом работают сторонние разработчики? Если да, то этот пост для вас :)

Работая с чужим кодом всегда возникает много вопросов: "Что? Куда? Почему?". Как правило, на эти ответы должна отвечать справка, которая распространяется вместе с кодом.

Компилировать свой код в .swc-библиотеки мы научились, теперь научимся легко и быстро собирать справки для них.

ASDoc

Разработчикам ActionScript 3.0 очень повезло. Для них уже имеется готовая утилита для сборки справки, поставляемая вместе с FlexSDK. Называется она ASDoc. Найти её можно в директории FlexSDK в поддиректории "bin".

Работает утилита из под командной строки. В параметрах принимает необходимые настройки и собирает справку на основе комментариев в исходном коде. В результате мы имеем папку "doc" c .html-файлами. Внешне справка выглядит также как официальная на сайте Adobe.

Подробнее читайте в справке по Flex:
Сборка справки во FlashDevelop

Естественно работать с утилитой ASDoc через командную строку неудобно, и во многих средах разработки есть свой "визард" для более удобной работы с ASDoc. И FlashDevelop не исключение.

Для этого у него имеется программа "Documentation Generator", которая находится в Tools > Flash Tools.



Рассмотрим по-подробнее:

Во вкладке "Project" указывается заголовок справки, классы которые нужно описать или пропустить, директория куда всё сложить, и версия ActionScript кода. Здесь можно собирать справку и для ActionScript 2.0, но в рамках данного поста мы это пропустим.



В "Settings" указывается путь к директории с утилитой ASDoc.



В "Output" выводится информация и процессе сборки справки.



И самое удобное, что все это можно сохранить в проект, который потом можно открыть.



Если что-то непонятно, имеется справка :)



Осталось нажать кнопку "Generate!"
                   

3 комментария:

  1. а как в Flash Builder 4 сгенерировать html к API пользовательских классов?

    ОтветитьУдалить
  2. Есть еще замечательный инструмент для генерирования документации - AsDocr от Гранта Скиннера. Он более удобный.

    ОтветитьУдалить
  3. Самое интересное что везде пишут про автогенерацию html документации, но сложно найти что-то путное по автоматическому комментированию, был какой то плагин кажется или включалось прямо в настройках автокомлита в ФД, при написании свойств и функций автоматом вставлялся камент

    ОтветитьУдалить

Можно использовать некоторые HTML-теги, например <b>, <i>, <a>

Поиск по блогу

Обо мне



Farid Shamsutdinov (AS3Coder)
Russia, Tatarstan, Kazan
as3coder@gmail.com

Подробнее...

Постоянные читатели

Рассылка

© 2014 Farid Shamsutdinov. При копировании материалов, ссылка на источник обязательна. Технологии Blogger.