Posso usare DoxyGen per documentare il codice ActionScript? [chiuso]

Question

Come si configura DoxyGen per documentare i file ActionScript?

Ho incluso i file * .as e * .asi nel modello di ricerca di doxygen, ma le classi, le funzioni e le variabili non vengono visualizzate qui.

Answer 1

Invece di doxygen dovresti usare un generatore di documentazione che supporti specificamente il linguaggio. Per ActionScript 2, hai un paio di scelte:

1. NaturalDocs ( esempio ) (gratuito)
2. ZenDoc (gratuito)
3. AS2Doc Pro ( esempio ) (commerciale)

Se si utilizza ActionScript 3, Adobe include un generatore di documentazione gratuito insieme al compilatore open source ( Flex SDK ), chiamato " ASDoc " ;. Se stai utilizzando FlashDevelop , ultima beta ha una GUI integrata per eseguire ASDoc, quindi non devi sporcarti le mani con la riga di comando.

Answer 2

Sono stato in grado di produrre QUALCHE documentazione con DoxyGen (Cosa posso dire - Mi piacciono le sue caratteristiche e capacità) Effettuando quanto segue:

Aggiungi * .as e * .asi all'elenco dei tipi di file da inserire.

Seleziona:

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

Un altro problema in AS3 è l'istruzione del pacchetto. Devi dire a DoxyGen di ignorare la definizione del pacchetto. Questo è facile da fare usando cond. Quindi cambierai la linea:

package myPackage {

in

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

Il che farà sì che Doxygen ignori le linee tra cond e endcond. Si noti che non sembra essere necessario fare lo stesso per la parentesi graffa di chiusura nella parte inferiore del file .as.

Answer 3

Puoi anche usare Ortelius. È più facile da usare rispetto a ASDoc poiché è dotato di una semplice interfaccia grafica ed è più perdonato al tuo codice. È gratuito e opensource, ma solo Windows.

ortelius.marten.dk