Shut the fuck up and write some code

グダグダ言わずにコードを書きたいブログ

FlashDevelopでドキュメント自動生成ツールを使う

コード読みを延々とやっているわけですが、ドキュメントもUMLもないのでクラスの関係性が全くわからない。とりあえずドキュメントを書き起こしてみようと思うものの、膨大過ぎて面倒。思えば世の中には便利な自動生成ツールがあったのだった。


ASって「AS2APIつ〜のがあるらしい」と思って調べてみると、FlashDevelopに最初から実装されてたという事実が発覚。しかもGUIで。とっても便利なのでメモ。


メニュー Tools → FlashTools →Documentation Generatorで起動


ウィンドウが表示されるので設定。
CompilerでAS2API(AS2)とASDoc(AS3)が選択できる。
ImportProjectでasxprojファイルが読み込めるのでプロジェクトの設定がそのままインポートできます。
Output先はAS2APIの場合日本語が混じった環境では動かないので注意。

ドキュメントを書くという行為自体いままで皆無だった・・・FL1.1ではそりゃそうだよな〜フレームごと/MCごとに書けるかっての。
サブクラスで継承したクラスのメソッドを見たりとかドキュメン超便利だ。コード書くにもドキュメントを意識してコメント書くようにしないと。


AS2APIがサポートしてるのはJavaDocなのでついでにJavaDocの書式もメモ。
http://www.hpc.cs.ehime-u.ac.jp/~aman/java/javadoc/
http://www5a.biglobe.ne.jp/~I-mutuki/prog/Java/javadoc/index.html


FlashDevelopを使うにはJavaDocの方が都合がよろしい、ということで。


とうとうドキュメントツールを使うようになった・・・すっかりプログラマーです。オレAS1しか書いたこと無いのに!