Flex講座 | ||
---|---|---|
Adobe Flex2.0について |
ASDoc
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);
}
}
}
/* 文字列操作を行う静的メソッドを集めたクラスです */
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 作者名
と記述します
fcshコマンド
Flexには便利な機能が用意されている普段はmxmlcコマンドでコンパイルを行う
しかし、このコンパイルを100倍早くする方法があるのだ
それは fcshコマンド である。
fcshとは Flex Compiler Shellの略で
2回目以降のコンパイルを100倍■早くすることができるコマンドである。
Flex Builderには基本実装されているが、コマンドをうってコンパイルする場合はこちらを使うことによって開発効率が上がる。
Flex 3 SDKにはfcshははじめから備わっているが、それ以前のFlex2では備わっていないため、サイトからダウンロードしなければならない。
■使用手順
コマンドライン上で
>fcsh
を入力すると
Adobe Flex Compiler SHell (fcsh)
Version 3.0.0 build 477
Copyright (c) 2004-2007 Adobe Systems, Inc. All rights reserved.
(fcsh)
Version 3.0.0 build 477
Copyright (c) 2004-2007 Adobe Systems, Inc. All rights reserved.
(fcsh)
と表示される
ここでmxmlファイルのコンパイルを行う
※ファイル名はフルパスで行うこと
(fcsh)mxmlc C:\test\Hello.mxml
次に2回目のコンパイルを行う場合は
(fcsh) compile 1
と入力する
以上によりfschコマンドを使用する事ができる
Flexではコンパイルに時間が掛かる場合が多いので、開発効率をあげるためにかかせないコマンドとなる