FlashDevelop3 RC3 から ASDoc を書き出すメモ

ASDoc の前の設定あれこれ

まず、以下の３つは前提条件。

• AS3 のプロジェクトを立ち上げている
• ASDoc タグをきちんと書いている
• Flex3 SDK のパスを通している

ASDoc タグについては、Flexのヘルプが参考になりますかね。なるんでしょうか。
まぁ、わからない人はググればいいと思います。
ASDoc タグ - Adobe Flex 3 ヘルプ
具体的な書き方とかは、ASDoc覚え書きの続き (godagoda.net) がわかりやすいです。

さて、Flex3 SDK のパス設定は、
[ Tools ] → [ Program Settings ] → [ ASContext ] → [ Flex SDK Location ]

例えばボクの場合は、Flex Builder3 を入れてるんで、その SDK を設定しています。
C:\Program Files\Adobe\Flex Builder 3\sdks\3.2.0
あ、Flex Builder 持ってない人は、以下の Adobe のサイトから SDK を落としてきて設定すれば OK です。
Adobe - Flexリソース：Flex 3 SDK リリースノート

んでんで、ここまで設定をした上で、
[ Tools ] → [ Flash Tools ] → [ Documentation Generator ] とすると、ダイアログ登場。

こっから、あれこれドキュメント設定すれば作れます！

ASDoc の書き出し

で、ボクがメモしたいのはこっから。
要はあのダイアログの使い方がよくわからなかったワケですよ。

まずは、Flex SDK の ASDoc にパスを通してやる必要ありと。
ジェネレータの [ Settings ] タブんところ。

ASDoc のあるフォルダを設定。例えばボクの場合は、
C:\Program Files\Adobe\Flex Builder 3\sdks\3.2.0\bin
ジェネレータの設定は保存できるので、[ Save Settings ] より保存しておくと便利。

続いてメインとなる、[ Project ] タブ。こちらは項目を箇条書き。順番はバラバラだけどすいません。

Complier

右下にあるプルダウンから、ASDOC (AS3) を選択しておきます。

Classpaths

ASDoc にしたいクラスパス（クラスフォルダ）。
これは、FlashDevelop のプロジェクトのクラスパスのこと。同じく絶対パスで指定。

Extra options

その他のオプション設定。たとえば、"-help advanced" で ASDoc のヘルプが見れたり。
詳しくは、ASDoc ツールの実行 - Adobe Flex 3 ヘルプや、[ヅラド] Flex ASDoc のヘルプ を参照してください。

Output directory

ASDoc の出力先ディレクトリ。相対パスではなく絶対パスで指定する。相対パスを入れると、FlashDevelop のプログラム領域（たとえば、C:\Program Files\FlashDevelop\Tools\asdocgen）に生成されちゃうので。
ちなみにボクの場合、たいていはプロジェクトの直下に "doc" ってゆうフォルダを作って、そこを指定。

Page title

ASDoc として出力される HTML の左上あたりに表示される文字。日本語入れるとうまくいかなかったよー　わーわー

Excluded classes

ASDoc の書き出しを行わないクラスを列挙してやる欄。複数ある場合は半角スペースで区切り、パッケージ名は完全なヤツで。たとえば、
jp.naggg.package1.MyClass1 jp.naggg.package1.MyClass2 ってカンジ。

今までのをまとめるとボクの場合、こうな風になると。

こんなカンジで一通り設定して、[ Generate! ] ボタンより書き出し開始。
クラスファイルの数が多いと書き出しに時間がかかりますねぇ・・・。
あ、ちなみに、フォルダパスはすべて絶対パスで指定するんだけど、日本語が含まれるパスはダメだった・・・　ここハマったぜ・・・　FlashDevelop は相変わらずマルチバイト文字に弱いっぽいので、面倒だけど、ASDoc を書き出すときだけフォルダパスを変えてやるとかで対応すればよいのではないのかと。
それと、これらの設定は、[ Save Project ] ボタンより、拡張子 docproj の XMLで保存ができます。
ダブルクリックで FlashDevelop で開かれるし、これも超絶に便利。

プロジェクトで fl パッケージを使ってる場合のトラブル対策

ASDoc 書き出しを実行すると、設定した Classpaths からソースにあるクラスファイルを再帰的に ASDoc にしていくんだけど、このときたとえば fl パッケージを利用してたりするとさぁ大変。コンパイルエラーでそこで ASDoc が停止みたいなゲロゲロ。畜生。ファックですねぇ。
そこであれこれ悩んでたんだけど、調べたら、オプション設定でいけるっぽい。
-compiler.strict=false
こうやって、コンパイラを緩くしてやればうまくいったのです。
これって fl パッケージじゃなくて、他の外部パッケージでも使えると思うですよねぇ。
さて、そうして書き出されたのが、jp.naggg パッケージの ASDoc。

最後に

まぁ、頑張って ASDoc について綴ってきたワケだけど、まぁそんなのどうでもいいワケです。
結局のところ、良いモノができればいいので、ASDoc 書き出してるヒマがあればソースをゴリゴリ書いてもっと良いモノ作れってことですよね。わかります。
精進します・・・。