僕のプログラムにコメントを付けない癖を改善すべくASDocを勉強することに。
一応メモ。
ASDocってのは、クラスやメソッドに書かれたコメントをHTMLにしてくれる優れものです。多分。
Flex Builder 2 か Flex 2 SDK がインストールされてれば使えます。多分。
早速実験。
ASDocはターミナルで、/Applications/Adobe Flex Builder 2/Flex SDK 2/bin/asdocを叩いて実行します。（Mac環境）
■asdoc コマンドの主なオプション
・-source-path ：Flexで作ったプロジェクトのファイルの場所です。
プロジェクトを、/Users/godagoda/study/flex/asdoc/に作ったら
asdoc -source-path /Users/godagoda/study/flex/asdoc/
ってな感じに指定します。多分。
・-doc-classes ：対象のクラスを指定します。
お目当てのクラスが、/Users/godagoda/study/flex/asdoc/net/godagoda/hoge/Example.asだったら、
asdoc -source-path /Users/godagoda/study/flex/asdoc/ -source-path net.godagoda.hoge.Example
ってな感じに指定します。多分。
複数指定したい場合には、単純に
asdoc -source-path /Users/godagoda/study/flex/asdoc/ -source-path net.godagoda.hoge.Example net.godagoda.hoge.Example2
てな感じに指定します。多分。
ポイントは、パスを"."で指定する事ですかね。ちなみに、指定したクラスと依存関係にあるその他のクラスも勝手に追加してくれます。
・-doc-sources ：プロジェクトファイルを検索して一気に作ってくれます。
-doc-sourcesでプロジェクトファイルの場所を指定すれば、再帰的に検索してくれるそうです。
-doc-sourcesを使う場合には、-source-pathの指定がいらないそうなので、
asdoc -doc-sources /Users/godagoda/study/flex/asdoc/
でな感じにしていすれば一気に作ってくれるはずです。
・-exclude-dependencies ：依存関係にあるクラスを勝手に追加するかどうかを設定します。
-doc-classesで、依存関係にあるクラスは勝手に追加されると書きましたが、その挙動を防ぐ時に設定します。多分。
この値をtrueに設定すると、勝手に追加されません。デフォルトはfalseです。
Exampleクラスの依存関係にあるクラスを追加したくない時には、
asdoc -source-path /Users/godagoda/study/flex/asdoc/ -source-path net.godagoda.hoge.Example -exclude-dependencies=true
てな感じに指定すれば、依存関係のクラスは追加されずに、Exampleだけが追加されます。多分。
・-exclude-classes string ：追加したくないクラスを設定します。
-doc-sourcesで一気にクラスを追加する時などに、このパラメータで追加したくないクラスを設定します。Example2を追加したくない時には、
asdoc -doc-sources /Users/godagoda/study/flex/asdoc/ -exclude-classes net.godagoda.hoge.Example2
てな感じに指定すれば、Example2は除外されます。多分。
これもパスを"."で指定します。
・-output ：出力先のディレクトリを指定します。
そのまんまです。作成されるHTMLなんかのファイルの出力先のディレクトリです。
/Users/godagoda/output/に出力したい時には、
asdoc -doc-sources /Users/godagoda/study/flex/asdoc/ -output /Users/godagoda/output/
てな感じに指定すれば、/Users/godagoda/output/に出力されているはずです。多分。
とりあえず、今はここまで。