Kann ich Doxygen Actionscript-Code zu dokumentieren? [geschlossen]

Question

Wie konfigurieren ich Doxygen Actionscript-Dateien zu dokumentieren?

Ich habe die * .as enthalten und * .asi Dateien in Suchmuster der doxygen, aber die Klassen, Funktionen und Variablen zeigen dort nicht.

Answer 1

Statt doxygen Sie einen Dokumentations-Generator verwenden sollen, die speziell auf die Sprache unterstützt. Für Actionscript 2, haben Sie ein paar Möglichkeiten:

1. NaturalDocs ( Beispiel ) (kostenlos)
2. ZenDoc (kostenlos)
3. AS2Doc Pro ( Beispiel ) (kommerziell)

Wenn Sie mit Actionscript 3 enthält Adobe einen kostenlose Dokumentation Generator zusammen mit ihrem Open-Source-Compiler (der Flex SDK ), genannt " ASDoc ". Wenn Sie mit FlashDevelop , die neueste beta eine für den Betrieb ASDoc in GUI gebaut hat, so dass Sie schmutzig haben nicht die Hände mit der Kommandozeile.

Answer 2

Ich habe in der Lage gewesen, eine Dokumentation mit Doxygen zu produzieren (Was kann ich sagen - Ich mag seine Eigenschaften und Fähigkeiten) Durch den folgenden Aktionen ausführen:

In * .as und * .asi in der Liste der Dateitypen eingeben.

Wählen Sie:

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 sagen, die Paketdefinition zu ignorieren. Dies ist leicht mit cond zu tun. So haben Sie die Zeile:

package myPackage {

in

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

Welche bewirkt, dass Doxygen die Zeile (n) zwischen Cond und ENDCOND ignorieren. Beachten Sie, dass es scheint nicht nötig zu sein, das gleiche gilt für die geschweiften Klammer am unteren Rand Ihrer .as-Datei zu tun.

Answer 3

Sie können auch Ortelius verwenden. Sein leichter als ASDoc zu verwenden, da es mit einem einfachen GUI kommt, und seine mehr, um Ihren Code vergeben. Sein freier und Open Source, aber nur unter Windows.

ortelius.marten.dk