新しくブログを開設しました。

Webエンジニアがデザイナーになってみる。


上記の広告は1ヶ月以上更新のないブログに表示されています。
新しい記事を書く事で広告が消せます。

新しくブログを開設しました。

Webエンジニアがデザイナーになってみる。


FlexにはActionScriptのプログラムにあるコメント等を元に、HTMLドキュメントを生成するツールがあります。
それがASDocです。

プログラムのドキュメント作成は大切です。
Java開発でもJavadocなどの存在は買いshつ社に無くてはならないものとなっています。

ドキュメント作成は労力がかかりますが、Flexにはこのドキュメントを比較的手軽に作成する事ができます。
クラスやメソッドの説明をコメントで書いておくと、それをもとに自動的にクラスを説明するドキュメントを作成してくれます。


■入手方法
Flex SDKをダウンロードすると入手できます。
SDKのbinフォルダに環境設定でパスを通す必要があります。

■使用方法
コマンドプロンプトを開いてください。

-基本書式-
ASDoc -doc-sources ソースファイルのパス

※注意点
文字コードはUTF-8にする必要があるそうです
日本語を含んでいるとうまく動作しない場合があるそうです

※C:\as3\test\Test.as

ASDoc -doc-sources ソースファイルのパス
>cd c:/as3
>ASDoc -doc-sources ./test



コメントの基本構文です

package{
  /* 文字列操作を行う静的メソッドを集めたクラスです */
  public class KString{
    /**
     * 文字列 str の a を b に置換する
     * @param str 置換対象文字列
     * @param a 検索文字列
     * @param b 置換文字列
     * @return 置換結果
    */

    public static function replace(str:String , a:String , b:String {
      var str_ary:Array = str.split(a);
      return str_ary.join(b);
    }
  }
}


クラス宣言の前に
/** 説明 */
とコメントを入れます

メソッドにも説明を入れます
引数に説明を入れる場合は
@param 変数名 説明
と入れます

戻り値に説明を入れる場合は
@return 説明
と入れます

他にも参照ページを指定する場合は
@see 参照ページ

作者の説明は
@author 作者名
と記述します



http://smileboys.fc2web.com/WebUtility/flex/flexTool.html
スポンサーサイト

テーマ:Flash - ジャンル:コンピュータ

<<HTML上でSWFを表示するには? | ホーム | Flexの単体テスト(UnitTest)について その2>>

コメント

コメントの投稿


管理者にだけ表示を許可する

トラックバック

トラックバック URL
http://kanamehackday.blog17.fc2.com/tb.php/70-4b654017
この記事にトラックバックする(FC2ブログユーザー)
上記広告は1ヶ月以上更新のないブログに表示されています。新しい記事を書くことで広告を消せます。