ActionScript用JavaDoc

ActionScriptからJavaDoc風ドキュメントを生成します。

ActionScript用JavaDoc

ふと思ってみると、最近ドキュメントをあまり書かなくなっている。基本設計は書くが、詳細設計レベルのドキュメントを作らない。徐々に機能追加して今のシステムになっている、スクリプト系言語などの理由があるのかも知れない。

だが、ソースからドキュメント生成ができるよう努める事は徹底するようになっている。一定のルールに沿ってコメントを書く事でAPIドキュメントを作成してくれるJavaDocだ。Javaのみならず、他の言語でも採用されている。

本日紹介するオープンソース・ソフトウェアはas2api、ActionScriptからJavaDocを生成してくれるソフトウェアだ。

利用法はWindows、またはMac OSX用に用意されたGUIインタフェースを使うか、rubyで用意されたCUIを利用するかだ。慣れるとCUIの方が楽になるだろう。

読み込むファイルはActionScriptの外部ファイル、*.asファイルになっている。ソースの場所を指定して実行すれば、HTMLファイルが生成されている。見た目は同梱されているCSSファイルを参照に修正すれば良い。

JavaDocの標準化が進めば、どのような言語であってもコメントの書き方（APIドキュメント向けの）が統一される。これはメリットが多い。形式を覚えて、書く癖をつけておこう。