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

Question

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

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

score 12 · Accepted Answer

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

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

score 3 · Accepted Answer

我已经能够使用 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 文件底部的右大括号执行相同操作。

score 2 · Accepted Answer

您也可以使用 Ortelius。它比 ASDoc 更易于使用，因为它带有一个简单的 GUI，并且更容易被您的代码所原谅。它是免费和开源的，但仅限于 Windows。

3 回答 3