ASDoc入りのSWCファイル「Fat SWC」の作り方

FlashではSWC(スウィク)ファイルを利用することで、ActionScriptのパブリッシュ/ビルドが早くなることを先日のSpark 勉強会で発表しました(「Spark project 勉強会 SP3」の発表ビデオ)。主にAS3ライブラリ開発者向けの情報になるのですが、そのSWCファイルにASDocコメントを含める方法を紹介します。

ASDoc入りのSWCファイル「Fat SWC」とは

通常のSWCファイルにはASDocコメントが含まれません。つまりコードヒントのコメントを利用できないというデメリットがありました。AS3登場後、様々なAS3ライブラリがSWCファイルで提供されていますが、そのほとんどがコメントなしのSWCです。

Fat SWCとは、SWCファイルにASDocコメントを含めた形式です。そのため対応したソフト(FlashDevelop 3.2.1やFlash Builder 4)では、ソースコード利用時と同様にコードヒントにASDocコメントを表示することができます。通常のSWCではASDocコメントは表示されません。ASDocコメントが表示されることは重要で、ヘルプを参照する手間を極力省くことができます。

[上:Fat SWCに対応しているFlashDevelop 3.2.1]

[上:Fat SWCに対応しているFlash Builder 4]

※FDTというエディターはFat SWCに対応しておらず、Fat SWCのASDocコメントは表示されないらしいです。

Fat SWCの構造

Flex SDKでFat SWCを作る場合は本来は次の手順を踏みます。

  1. SWCファイルを生成する
  2. ASDocをXMLで生成する
  3. SWCファイルをZIPとして(.swcを.zipにリネームしてから)解凍する
  4. SWC内にASDocのXMLをコピーする
  5. SWCファイルをZIPとして圧縮し、拡張子を.swcに戻す
  6. 完成

完成したファイルは次のように「docs」フォルダがあり、XMLファイルが格納されています。XMLにはASDocのコメント情報が記述されています。

[左:Fat SWC、右:通常のSWC]

ただ、この手順を踏むのは非常に不便です。試したところ、Flash Builder 4でAntタスクを利用して半自動的に行うのがベストでしたので、その方法を紹介します。Antタスクとは、コンパイルや諸々の作業を専用のXMLファイルに記述して自動実行するツールです。

Flash Builder 4でFat SWCの作り方

(1)Flash Builderで「ライブラリプロジェクトを作成」します。

(2)「src」フォルダにSWC化したいAS3ライブラリのソースファイルを格納。ここでは例として、Spark Projectからダウンロードできる「BetweenAS3」を利用しています。

(3)Antビルド用の、build.xmlをプロジェクト内にコピーします。build.xmlはこちらからダウンロードください。(Macの設定ファイルを記述しています。Windowsの場合はWindowsのFlex SDKのパスを修正ください)

AntはFlash Builder 4にプリインストールされていないので、されているかは忘れてしまったのですが、もし入っていない場合は記事「FlashBuilder 4 に Ant を導入する – まさにっき(コードで世界を変えたい人の記録)」を参考にプラグインをインストールします。

(4)[パッケージエクスプローラ]の「build.xml」を右クリックし[実行]→[Ant Build]を選択してAnt ビルドを実行します。

(5)[コンソール]パネルにログが表示され(一部文字化けのログもでる)数十秒待つと、「BUILD SUCCESSFUL」と表示されます。

(6)プロジェクトの「bin」フォルダを確認します。そこにはSWCファイル「mylib_fatswc.swc」が生成されていますが、これがASDoc入りのFat SWCです。ファイル名は自由に変更して利用できます。

以上となります。

それではFat SWCで、効率のよいコーディングを!

参考記事

当ブログ内の関連記事

投稿者 : 池田 泰延

BookMark

いかがでしたでしょうか、ブックマークはこちらからどうぞ。

このエントリーをはてなブックマークに追加

Comment/Trackback 6件