我可以使用DoxyGen来记录ActionScript代码吗? [关闭]
-
02-07-2019 - |
题
如何配置DoxyGen来记录ActionScript文件?
我在doxygen的搜索模式中包含了* .as和* .asi文件,但是类,函数和变量都没有显示在那里。
解决方案
您应该使用专门支持该语言的文档生成器,而不是doxygen。对于ActionScript 2,您有几个选择:
- NaturalDocs (示例)(免费)
- ZenDoc (免费)
- AS2Doc Pro (示例)(商业) 醇>
如果您使用的是ActionScript 3,Adobe会将免费文档生成器及其开源编译器包含在内( Flex SDK ),名为” ASDoc ”。如果您使用的是 FlashDevelop ,则最新测试版有一个用于运行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,并且它对你的代码更加宽恕。它的免费和开源,但只有窗口。
不隶属于 StackOverflow