フラッシュ制作をしていくと、
「俺の、俺による、俺のためのクラス」がちまちま作られていくわけですが、
見返してみるとこのクラス結局何したいの？
っていうのが大量発生するわけです。
そこで、自分が汗水流して作ったクラスちゃん達を
埋もれさせないためになにかドキュメントにまとめたい。
そんなときにはこれ！
「ASDoc！」
なじみがあるのは、FlashのビルドインクラスやProgressionのASDocかと思われます。
・ActionScript 3.0 コンポーネントリファレンスガイド
http://livedocs.adobe.com/flash/9.0_jp/ActionScriptLangRefV3/
・Progression 3.1 – API Reference
http://asdoc.progression.jp/
あ、なんかプロっぽくていいね！すごくいい！
では、早速作ります。
■用意するもの
・FlashDevelop 3.1.1 RTM
・flex_sdk_4
では、FlashDevelopの画面から、
ツール(T)→Flashツール(F)→ASDocジェネレーター(D)
で、ActionScript Documentation Generatorの
Output directoryにASDocのHTMLファイルを入れるフォルダを作ります。
ClassPathsには、丹精こめた自分のライブラリーにパスを合わせて、
CompilerのプルダウンからASDOC(AS3)を選択します。
次に、上部のタブ「Settings」の
ASDoc locationにFlex SDKのbinフォルダにパスを合わせます。
はい！最後に念願の「Generate!」ボタンをクゥリィック！！！
はい！出来た！いいやつ出来たよ！
では、ASDocのフォルダのindex.htmlを拝見すると、
できた！？
あれ？コメントとか、何にも表示されてない！
そうです。あれは自力で書きます。
書き方には作法がありまして、
以下のようにして書くとプロっぽい仕様になるかと思います。
■タグ
・表示されたタグ
@see http://example.com/
@example ただし
・表示されなかったタグ
@author
@param
@return
@exampleText
■例
import flash.ui.Keyboard;
/**
クラスのメイン説明. ← ドットと半角スペースで次の詳細説明に移る
詳細説明
@see http://example.com/
@example
public function MyExample() {
trace(“使い方”)
}
}
public class example extends Sprite{
public function example() {
}
}
やったぜ！
