我可以使用DoxyGen来记录ActionScript代码吗？

Question

如何配置DoxyGen来记录ActionScript文件？

我在doxygen的搜索模式中包含了* .as和* .asi文件，但类，函数和变量都没有显示在那里。

Answer 1

您应该使用专门支持该语言的文档生成器，而不是doxygen。对于ActionScript 2，您有几个选择：

1. NaturalDocs（example）（免费）
2. ZenDoc（免费）
3. AS2Doc Pro（example）（商业）

如果您使用的是ActionScript 3，则Adobe会包含一个免费的文档生成器及其开源编译器（Flex SDK），称为“ASDoc”。如果您使用FlashDevelop，latest beta有一个用于运行ASDoc的内置GUI，因此您不必使用命令行弄脏您的手。

Answer 2

我已经能够使用DoxyGen生成一些文档（我能说什么 - 我喜欢它的特性和功能）通过执行以下操作：

将* .as和* .asi添加到要输入的文件类型列表中。

选择

OPTIMIZE_OUTPUT_JAVA   = YES
EXTRACT_ALL            = YES
HIDE_UNDOC_MEMBERS     = NO
HIDE_UNDOC_CLASSES     = NO

AS3中的另一个问题是package语句。 您需要告诉DoxyGen忽略包定义。这很容易使用cond。 所以你要换行：

package myPackage {

进入

/// @cond
package myPackage {
/// @endcond

这将导致Doxygen忽略cond和endcond之间的行。 请注意，似乎没有必要对.as文件底部的右大括号执行相同的操作。

Answer 3

您也可以使用Ortelius。它比ASDoc更容易使用，因为它带有一个简单的GUI，并且它对你的代码更加宽恕。它的免费和开源，但只有窗口。

ortelius.marten.dk