Wie konfiguriere ich DoxyGen, um ActionScript-Dateien zu dokumentieren?Kann ich mit DoxyGen ActionScript-Code dokumentieren?
Ich habe die * .as und * .asi-Dateien in Doxygen Suchmuster enthalten, aber die Klassen, Funktionen und Variablen werden dort nicht angezeigt.
Anstelle von Doxygen sollten Sie einen Dokumentationsgenerator verwenden, der speziell die Sprache unterstützt. Für Actionscript 2, haben Sie ein paar Möglichkeiten:
Wenn Sie mit ActionScript 3, Adobe enthält einen kostenlosen Dokumentationsgenerator mit seinem Open-Source-Compiler (Flex SDK), genannt "ASDoc". Wenn Sie FlashDevelop verwenden, verfügt das latest beta über eine integrierte Benutzeroberfläche zum Ausführen von ASDoc, so dass Sie sich nicht die Hände mit der Befehlszeile schmutzig machen müssen.
Ich habe einige Dokumentation mit Doxygen zu produzieren in der Lage (Was kann ich sagen - ich seine Eigenschaften und Fähigkeiten mag) durch folgende Maßnahmen:
Add * .as und * .asi in der Liste der Datei Eingabearten.
Select:
OPTIMIZE_OUTPUT_JAVA = YES
EXTRACT_ALL = YES
HIDE_UNDOC_MEMBERS = NO
HIDE_UNDOC_CLASSES = NO
Ein weiteres Problem in AS3 ist die Paketanweisung. Sie müssen DoxyGen anweisen, die Paketdefinition zu ignorieren. Dies ist einfach mit cond zu tun.
package myPackage {
in
/// @cond
package myPackage {
/// @endcond
Welche Doxygen bewirkt, dass die Linie (n) zwischen Cond und ENDCOND ignorieren: So werden Sie die Zeile ändern. Beachten Sie, dass die schließende geschweifte Klammer am Ende der .as-Datei nicht erforderlich zu sein scheint.
Sie können auch Ortelius verwenden. Es ist einfacher zu verwenden als ASDoc, da es mit einer einfachen GUI ausgestattet ist und Ihrem Code mehr vergeben wird. Es ist kostenlos und opensource, aber nur Windows.
Es funktioniert nicht für mich. Doxygen erkennt die Grammatik von AS3 überhaupt nicht. Es analysiert die Funktionskörper fälschlicherweise als "Public Member Functions" usw. –