FlashDevelopでASDoc作成

今回は、FlashDevelopでASDocを作成した際のメモです。FlashDevelopを使うとActionScriptライブラリのリファレンス等が簡単に作成できるので、正直驚きました。私は、Mac OS XのVMware FusionでインストールしたWindows7上のFlashDevelopを使用しました。

コメントの書き方

FlashDevelopのインストールや設定、日本語化はFlashDevelop.jpで詳しく解説されています。

まずASDocを作成する前に、ドキュメント化したいActionScriptのクラスファイルに適切にコメントを入れておく必要があります。プロパティやメソッドの説明は下記のようにコメントを入れます。説明が複数行にわたる場合は、最初の.(ドット)までが概要として扱われるので注意が必要です。

ActionScript3.0

/**
 * 最初のドットまでが概要として扱われます.
 * それ以降に詳細な説明文を入れます。
 */
public function foo():void {
		
}

プロパティのデフォルト値を明示するには、下記[email protected] に続いて初期値を記述します。

ActionScript3.0

/**
 * 概要文.
 *
 * @default false
 */
public function get bar():Boolean {

}

次に引数と戻り値の説明を入れてみます。引数の[email protected] 引数の変数名 に続いて引数の説明文を入れます。戻り値の説明[email protected] に続いて戻り値の説明文を入れます。

ActionScript3.0

/**
 * 概要文.
 *
 * @param str 引数の説明
 * @return 戻り値の説明
 */
public function hoge(str:String):Point {
		
}

[email protected] に続いて記述例の説明文を記述し、続いて<listing version="3.0">と</listing>の間にコードを記述します。

ActionScript3.0

/**
 * 概要文.
 *
 * @example コードの記述例の説明文。
 * <listing version="3.0">
 * コード
 * </listing>
 */
public function piyo():void {

}

次にドキュメント化したくないプロパティやメソ[email protected][email protected]メント化されなくなります。

ActionScript3.0

/**
 * このメソッドはドキュメント化されない.
 *
 * @private
 */
public function LiquidLayouter() {
		
}

ASDocの書き出し

準備が出来たら、ASDocの作成に入ります。FlashDevelopを起動し、ツールメニュー > Flashツール > ASDocジェネレーターを選択し、表示されたウィンドウの上部のPage title:にドキュメントのタイトルを入力します。

次にOutput directory:の右にあるBrowseボタンをクリックして、HTMLを出力するフォルダを選択します。下図の例では、デスクトップ上のreferenceフォルダを指定しています。

次にClassPaths:の右にあるBrowseボタンをクリックして、ドキュメント化したいクラスファイルのディレクトリを選択します。下図の例では、デスクトップ上に置いたLiquidLayouterのパッケージを指定しています。

次にCompiler:の項目でASDOC(AS3)を選択してから、右下にあるGenerateボタンをクリックします。

以上で作業自体は完了です。ウィンドウの上部のタブをOutputに切り替えて、ドキュメントの書き出しが終わるのを待ちます。「ドキュメントは、〜に作成されました」とメッセージが表示されたら、書き出しが完了しています。

Output directoryに指定したフォルダに必要なファイルが書き出されているので、index.htmlをWebブラウザで開いて確認しましょう。

以上のように、簡単にASDocが作成できるので、とても便利です。他人にライブラリを公開する場合はもちろん、自分自身が作成したクラスでも数年も経つと書いたスクリプトを忘れてしまうものだと思うので、積極的に活用していきたいですね。