feeds2011/05/04カテゴリー:ActionScriptFlashDevelopでASDoc作成Tweet今回は、FlashDevelopでASDocを作成した際のメモです。FlashDevelopを使うとActionScriptライブラリのリファレンス等が簡単に作成できるので、正直驚きました。FusionでインストールしたWindows7上のFlashDevelopを使用しました。目次コメントの書き方ASDocの書き出しコメントの書き方FlashDevelopのインストールや設定、日本語化はFlashDevelop.jpで詳しく解説されています。ASDocを作成する前に、ドキュメント化したいActionScriptのクラスファイルに適切にコメントを入れておく必要があります。プロパティやメソッドの説明は下記のようにコメントを入れます。説明が複数行にわたる場合は、最初の.(ドット)までが概要として扱われるので注意が必要です。それ以降に詳細な説明文を入れます。続いて初期値を記述します。{}次に引数と戻り値の説明を入れてみます。続いて引数の説明文を入れます。続いて戻り値の説明文を入れます。version="3.0">と</listing>の間にコードを記述します。コードの記述例の説明文。protected]�メント化されなくなります。{}ASDocの書き出し準備が出来たら、ASDocの作成に入ります。title:にドキュメントのタイトルを入力します。directory:の右にあるBrowseボタンをクリックして、HTMLを出力するフォルダを選択します。下図の例では、デスクトップ上のreferenceフォルダを指定しています。次にClassPaths:の右にあるBrowseボタンをクリックして、ドキュメント化したいクラスファイルのディレクトリを選択します。下図の例では、デスクトップ上に置いたLiquidLayouterのパッケージを指定しています。次にCompiler:の項目でASDOC(AS3)を選択してから、右下にあるGenerateボタンをクリックします。以上で作業自体は完了です。ウィンドウの上部のタブをOutputに切り替えて、ドキュメントの書き出しが終わるのを待ちます。「ドキュメントは、〜に作成されました」とメッセージが表示されたら、書き出しが完了しています。directoryに指定したフォルダに必要なファイルが書き出されているので、index.htmlをWebブラウザで開いて確認しましょう。以上のように、簡単にASDocが作成できるので、とても便利です。他人にライブラリを公開する場合はもちろん、自分自身が作成したクラスでも数年も経つと書いたスクリプトを忘れてしまうものだと思うので、積極的に活用していきたいですね。