Могу ли я использовать DoxyGen для документирования кода ActionScript?

Как настроить DoxyGen для документирования файлов ActionScript?

Я включил файлы *.as и *.asi в шаблоне поиска doxygen, но классы, функции и переменные там не отображаются.

Ответ 1

Вместо doxygen вы должны использовать генератор документации, который специально поддерживает язык. Для ActionScript 2 у вас есть несколько вариантов:

NaturalDocs (example) ( бесплатно)
ZenDoc (бесплатно)
AS2Doc Pro (example) (коммерческий )

Если вы используете ActionScript 3, Adobe включает в себя бесплатный генератор документации вместе с их компилятором с открытым исходным кодом (Flex SDK), называемый "ASDoc ". Если вы используете FlashDevelop, последняя бета-версия встроенный графический интерфейс для запуска ASDoc, поэтому вам не нужно загрязнять руки с помощью командной строки.

Ответ 2

Я смог создать документацию с 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 будет игнорировать линию (линии) между cond и endcond. Обратите внимание, что, похоже, нет необходимости делать то же самое для закрывающей фигурной скобки внизу вашего файла .as.

Ответ 3

Вы также можете использовать Ortelius. Его проще в использовании, чем ASDoc, поскольку он поставляется с простым графическим интерфейсом и более прост в использовании вашего кода. Его бесплатный и openource, но только окна.

ortelius.marten.dk