Я могу использовать DoxyGen для документирования Кода ActionScript? [закрытый]
3 ответа
Вместо doxygen необходимо использовать генератор документации, который конкретно поддерживает язык. Для ActionScript 2 у Вас есть пара выбора:
- NaturalDocs (бесплатный) (пример)
- (Свободный) ZenDoc
- (Коммерческий) (пример) AS2Doc Pro
При использовании ActionScript 3 Adobe включает генератор свободной документации наряду с их компилятором с открытым исходным кодом (Flex SDK), названный "ASDoc". При использовании FlashDevelop последняя бета имеет созданный в GUI для выполнения ASDoc, таким образом, Вы не должны пачкать руки с командной строкой.
Я смог произвести НЕКОТОРУЮ документацию с DoxyGen (Что может я говорить - мне нравятся его функции и возможности) Путем выполнения следующего:
Добавьте *.as и *.asi к списку типов файлов для ввода.
Выбор:
OPTIMIZE_OUTPUT_JAVA = YES
EXTRACT_ALL = YES
HIDE_UNDOC_MEMBERS = NO
HIDE_UNDOC_CLASSES = NO
Другой проблемой в AS3 является оператор пакета. Необходимо сказать DoxyGen игнорировать определение пакета. Это легко сделать конусовидное использование. Таким образом, Вы измените строку:
package myPackage {
в
/// @cond
package myPackage {
/// @endcond
Который заставит Doxygen игнорировать строку (строки) между конусовидным и endcond. Обратите внимание, что, кажется, нет никакой потребности сделать то же для заключительной фигурной скобки у основания Вашего .as файла.
Вы также можете использовать Ортелиус. Его проще использовать, чем ASDoc, поскольку он имеет простой графический интерфейс и более понятен вашему коду. Это бесплатно и с открытым исходным кодом, но только для Windows.