Как настроить DoxyGen для документирования файлов ActionScript?Могу ли я использовать DoxyGen для документирования кода ActionScript?
Я включил файлы * .as и * .asi в шаблон поиска doxygen, но классы, функции и переменные там не отображаются.
Вместо doxygen вы должны использовать генератор документации, который специально поддерживает язык. ActionScript 2, у вас есть пара вариантов:
Если вы используете ActionScript 3, Adobe включает в себя бесплатный генератор документации вместе с их компилятором с открытым исходным кодом (Flex SDK) под названием «ASDoc». Если вы используете FlashDevelop, то latest beta имеет встроенный графический интерфейс для запуска ASDoc, поэтому вам не нужно загрязнять руки с помощью командной строки.
Я был в состоянии производить некоторые документы с Doxygen (Что я могу сказать - я люблю ее функции и возможности), выполнив следующие действия:
Добавить * .as и * .asi к списку файлов типы для ввода.
Выбрать:
OPTIMIZE_OUTPUT_JAVA = YES
EXTRACT_ALL = YES
HIDE_UNDOC_MEMBERS = NO
HIDE_UNDOC_CLASSES = NO
Другой вопрос в AS3 является пакет заявление. Вам нужно сообщить DoxyGen, чтобы игнорировать определение пакета. Это легко сделать, используя cond. Таким образом, вы измените строку:
package myPackage {
в
/// @cond
package myPackage {
/// @endcond
который заставит Doxygen игнорировать линию (ы) между кондом и endcond. Обратите внимание, что, похоже, нет необходимости делать то же самое для закрывающей фигурной скобки внизу вашего .as-файла.
Вы также можете использовать Ortelius. Его проще в использовании, чем ASDoc, поскольку он поставляется с простым графическим интерфейсом и более прост в использовании вашего кода. Его бесплатный и open source, но только окна.
Это не работает для меня. Doxygen вообще не распознает грамматику AS3. Он неправильно анализирует тела функций как «Public Member Functions» и т. Д. – 2013-07-15 10:38:12