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

Question

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

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

Answer 1

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

1. NaturalDocs (пример) (бесплатно)
2. ЗенДок (бесплатно)
3. AS2Doc Про (пример) (коммерческий)

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

Answer 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-файла.

Answer 3

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

ortelius.marten.dk