ActionScript kodunu belgelemek için DoxyGen kullanabilir miyim?

Question

ActionScript dosyalarını belgelemek için DoxyGen'i nasıl yapılandırabilirim?

* .as ve * .asi dosyalarını doxygen arama desenine ekledim, ancak sınıflar, işlevler ve değişkenler burada gösterilmiyor.

Answer 1

Doxygen yerine, özellikle dili destekleyen bir belge üreticisi kullanmalısınız. Eğer kullanıyorsanız

1. NaturalDocs (example) (serbest)
2. ZenDoc (serbest)
3. AS2Doc Pro (example) (ticari)

: ActionScript 2, bir kaç seçenek var ActionScript 3, Adobe, "ASDoc" adı verilen açık kaynak derleyicileriyle birlikte (Flex SDK) ücretsiz bir dokümantasyon oluşturucu içerir. FlashDevelop kullanıyorsanız, latest beta, ASDoc çalıştırmak için yerleşik bir GUI'ye sahiptir, bu nedenle elinizi komut satırıyla kirletmeniz gerekmez.

Answer 2

I (Ne diyebilirim - Ben özelliklerini ve yeteneklerini gibi) Doxygen ile BAZI belgeleri üretmek mümkün oldum

aşağıdaki yaparak: Dosyanın listesine

Ekleme * .as ve * .asi giriş türleri.

seçin: AS3'te

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

diğer konu paketi ifadedir. DoxyGen'in paket tanımını yok saymasını söylemelisiniz. Bu cond kullanarak yapmak kolaydır.

package myPackage { 

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

içine Doxygen koşul ve endcond arasındaki çizgiyi (ler) görmezden neden olur: Yani çizgiyi değiştireceğiz. .as dosyanızın alt kısmındaki kapanış süslü parantez için aynı şeyi yapmaya gerek olmadığını unutmayın.

Answer 3

Ayrıca Ortelius'u da kullanabilirsiniz. Basit bir GUI ile geldiğinden ve kodunuza daha fazla bağışlanmasından dolayı ASDoc'tan daha kolay kullanılır. Onun özgür ve açık kaynak, ama sadece pencereler.

ortelius.marten.dk