Flasherの強い味方、ASDocで簡単ドキュメンテーション

FITC皆さんご覧になられましたか？FITCビデオを通勤途中に見るのが密かな楽しみになっているMuraiです。

さて今回はFlasherの資料作成の強い味方、Asdocを簡単に作るAIRの紹介です。

Asdocって？

ASDocはJavadocを模したActionScriptのドキュメントです。
主にはこのクラスのプロパティとメソッドは〜でというAdobeのリファレンスでおなじみこの形の物になります。
Flex sdkをいれるとasdocというコマンドラインツールがあるので、その子にソースフォルダを指定するとAdobeのリファレンスと同じものが自動出力されるという便利ツールです。
 

記述方法

とても簡単。
書きたいメソッドやプロパティの上に下記の様に書き込みます。

        /**
         * ここに概要とかを書きます。
         * @example ソース例のコメント
         * <listing version="3.0">this.is.code.area("listingで囲まれた部分にこんな風にコードを書けます");</listing>
         * @param パラメータ
        * @see com.kayac.level0.Murai
        * @return String
         */

使ってみよう！

Flashやってる人は基本的にcmd.exeやterminal.appをいじる人ばかりではないので神様が作ったGUIツールを使いましょう。

使うアプリはGrantSlinner先生のairアプリASDocrです。
英語ですがそれは我慢するとして、最短の設定をご紹介。

まずはインストール。神様のサイトに行きます。
http://gskinner.com/blog/archives/2010/01/asdocr_simple_a.html
MacのdmgかWinのexeをダウンロード。インストールします。

立ち上げて設定。

ASDocタブ

asdocのpathを設定。
Macだと
/Applications/Adobe Flash Builder Beta 2/sdks/4.0.0/bin/asdoc
とかです。

Basicタブ

configuration Name:
設定した内容をテンプレにして保存しておけます。
その名前。上のコンボボックスで選択切り替え可能です。

source-path:
出力したいソースフォルダのルートパスを指定

output:
ASDocの書き出し先

Outputタブ

main-title:
ASDocのタイトル
API Wrapper Refference とか。

footer:
フッターに入る内容
Takashi Murai - KAYAC inc とか。

window-title:
API Wrapper Refference と僕はmain-titleと共通しています。

templates-path:
flex sdkの中のtemplateのパスです。
 

後は適宜好みで設定ですね。
このASdocがあると概要の整理や急な引き継ぎ、大きいプロジェクトならジョインした新たな仲間への共有も簡単です。

チームでFlash開発する方や，更新案件を持てない方など、是非試してみたください！