ASDocTweetこんにちは。コーディングをしていると、「この辺のプログラム、どんな形式でもいいからドキュメント書いて出して」なんて突然言われて気が重くなっちゃうことがありますよね。プログラマーはドキュメントの作成がとっても苦手なので、「あぁ・・・もうコメント書いてASDocでHTML出力しちゃえばいいかな・・・」ということになりがちです。そんなときに役立つ、FlashBuilderからASDocを簡単に生成する方法を紹介します。これを設定しておけば、いつでもボタン一つでASDocが出力できます。そもそもASDocって何?という話ですが、クラスやメソッドに付けたコメントを元に、見やすくHTML形式のドキュメントを出力してくれるものです。簡潔に書くとこんな形式のコメントを使用します。.....詳細なコメントのフォーマットは以下のURLを参照してください。http://livedocs.adobe.com/flex/3_jp/html/help.html?content=asdoc_1.htmlASDocはFlexSDKがあれば作成可能で、本来はコマンドラインで動かすものらしいのですが、FlashBuilder(FlexBuilderでも)から簡単に作れるようなのでやってみました。手順は以下の通りです。新規構成画面が表示されるので項目を埋める以下は今回の設定例です。ASDocこれはなんでもいいです。${project_loc}この文字列を書いておけば選択しているプロジェクトが自動的に使用されます。srcスクリプトを保存しているディレクトリ(ここではsrcディレクトリ)を指定。この赤丸のところのボタンを使っても実行できます。生成に成功するとasdoc-output内に大量のファイルが生成されます。index.htmlがトップページになるのでそれを開きましょう。こんな感じのHTMLができました!項目が少なくてショボかったので適当なメソッドを追加してます。image:Image」なんてのが出力されて、何だこれ?となったのですが、これはMXML上でidを登録しているオブジェクトが自動的に表示されてるんですね。そもそもコメント書いてないから今更書くのめんどくさい・・・そんな場合、FlexFormatterプラグインが便利です。comments」機能を使えば、各クラス・メソッド・変数に自動的にコメントを付けてくれます。{}ここまでコメントを作ってくれます。解説文は自分で入れる必要があります。.asファイルにしか対応していないため、MXMLファイル内にASゴリゴリ書いている人は恩恵を受けられません。byスターをつけました引用をストックしましたストック一覧を見る閉じる引用するにはまずログインしてくださいログイン閉じる引用をストックできませんでした。再度お試しください閉じる限定公開記事のため引用できません。