我可以使用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的一些文檔（我能說什麼 - 我喜歡它的特性和功能）通過執行以下操作：

添加*。至於和* .asi到文件列表類型輸入。

選擇：

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

另一個問題在AS3是包語句。 您需要告訴DoxyGen忽略軟件包定義。使用cond很容易。 所以你會改變線路：

package myPackage { 

到

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

，這將導致的Doxygen忽略COND和ENDCOND之間的線（S）。 請注意，似乎沒有必要對.as文件底部的結束括號括起來。

Answer 3

您也可以使用Ortelius。它比ASDoc更易於使用，因爲它帶有一個簡單的GUI，並且它更加原諒您的代碼。它的免費和開源，但只有窗戶。

ortelius.marten.dk