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

时间:2020-03-06 14:41:07  来源:igfitidea点击:

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

我已经在doxygen的搜索模式中包括了* .as和* .asi文件,但是其中没有显示类,函数和变量。

解决方案

我们应该使用专门支持该语言的文档生成器来代替doxygen。对于ActionScript 2,我们有两种选择:

  • NaturalDocs(示例)(免费)
  • ZenDoc(免费)
  • AS2Doc Pro(示例)(商业)

如果我们使用的是ActionScript 3,则Adobe将包括一个免费的文档生成器以及名为" ASDoc"的开源编译器(Flex SDK)。如果我们使用的是FlashDevelop,则最新的Beta版具有用于运行ASDoc的内置GUI,因此我们不必使用命令行弄脏手。

通过执行以下操作,我已经能够使用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文件底部的大括号进行同样的操作。

我们也可以使用Ortelius。它比ASDoc更易于使用,因为它带有简单的GUI,并且对代码更宽容。它是免费和开源的,但仅适用于Windows。

ortelius.marten.dk