godagoda.net

僕のプログラムにコメントを付けない癖を改善すべくASDocを勉強することに。
一応メモ。

ASDocってのは、クラスやらメソッドやらプロパティやらに書かれたコメントをHTMLにしてくれる優れものです。
Flex 2 SDK がインストールされてれば使えます。

早速実験。
ASDocはターミナルで、/Applications/Adobe Flex Builder 2/Flex SDK 2/bin/asdocを叩いて実行します。（Mac環境）

■asdoc コマンドの主なオプション
・-source-path　：クラスファイルがあるディレクトリを指定します。
ソースファイルを/Users/godagoda/study/flex/asdoc/に作ったら

・-doc-classes　：対象のクラスを指定します。
お目当てのクラスが、/Users/godagoda/study/flex/asdoc/net/godagoda/hoge/Example.asだったら、

ってな感じに指定します。
複数指定したい場合には単純に、

てな感じに指定します。多分。
ポイントは、パスを"."で指定する事ですかね。ちなみに、指定したクラスと依存関係にあるその他のクラスも勝手に追加してくれます。

・-doc-sources　：プロジェクトファイルを検索して一気に作ってくれます。
-doc-sourcesでソースファイルの場所を指定すれば、再帰的に検索してくれるそうです。
-doc-sourcesを使う場合には、-source-pathの指定がいらないそうなので、

でな感じにしていすれば一気に作ってくれるはずです。

・-exclude-dependencies　：依存関係にあるクラスを勝手に追加するかどうかを設定します。
-doc-classesで、依存関係にあるクラスは勝手に追加されると書きましたが、その挙動を防ぐ時に設定します。多分。
この値をtrueに設定すると、勝手に追加されません。デフォルトはfalseです。
Exampleクラスの依存関係にあるクラスを追加したくない時には、

てな感じに指定すれば、依存関係のクラスは追加されずに、Exampleだけが追加されます。多分。

・-exclude-classes string　：追加したくないクラスを設定します。
-doc-sourcesで一気にクラスを追加する時などに、このパラメータで追加したくないクラスを設定します。Example2を追加したくない時には、

てな感じに指定すれば、Example2は除外されます。
これもパスを"."で指定します。

・-output　：出力先のディレクトリを指定します。
そのまんまです。作成されるHTMLなんかのファイルの出力先のディレクトリです。
/Users/godagoda/output/に出力したい時には、

てな感じに指定すれば、/Users/godagoda/output/に出力されているはずです。

とりあえず、今はここまで。

引き続きASDocの覚え書き。

■コメントの書き方
コメントは、下記の様に/**で始まり、*/で終わります。

/**
* Main comment text.
*
*/

ベストプラクティスは、ASDoc コメントの各行の前にアスタリスク (*) 文字を付け、その後に 1 つの空白を挿入することにより、ActionScript または MXML ファイルでコメントを読みやすくし、コメントを正しく解析できるようにします。だそうです。

ちなみに、ソースをUTF-8で保存しておけば、日本語ちゃんと表示されます。
HTMLのタグも使えちゃったりします。以下使える主なタグ。
<p><listing><pre><br><ul><li><table><th><tr><td><img><code><strong><em>

実際にコメントを配置する場所は、クラス、インターフェス、メソッド、プロパティの宣言の直前に、配置します。

/**
* ここにコメントを書きます。
*
*/
public function hoge():Void{}

■ASDocのタグ
ASDocには、頭に@が付く独自のタグが用意されてます。
このタグを使えば、他のコメントをコピーできたり、コメントを非表示に出来たりします。
以下主なタグです。

・@private
このタグが付けられると、コメントが非表示になります。
クラス自体を非表示にしたい時には、クラスのコメントにこのオプションを付ければ、そのクラス全体が非表示になります。-exclude-classesオプションと同じですかね。

/**
* CommentCommentCommentComment
*
* @private
*/

・@default
プロパティの初期値を宣言できます。

/**
* The default value of text
*
* @default defaultStringValue
*/
public var defaultString:String = "defaultStringValue";

・@param
メソッドの引数を宣言できます。

/**
* The default value of text
*
* @param param1 Describe param1 here
* @param param2 Describe param2 here
*/
public function hoge(param1:String, param2:Number):Boolean {}

・@return
メソッドの戻り値を宣言できます。
/**
* The default value of text
*
* @param param1 Describe param1 here
* @param param2 Describe param2 here
* @return Describe return here
*/
public function hoge(param1:String, param2:Number):Boolean {
return true;
}

以上こんな感じですかね。

FlexでVideoDisplayをいじったので、メモ。

・cuePointManagerを使う
cuePointManagerを使いたい場合は、cuePointManagerClassプロパティに、
「mx.controls.videoClasses.CuePointManager」と設定する。
これでcuePointManagerが使用可能になる模様。

video(インスタンス).cuePointManagerClass= mx.controls.videoClasses.CuePointManager;

・addCuePointを使う
addCuePointには、引数として、「name」と「time」のプロパティを持ったオブジェクトを指定する。
独自のプロパティも渡したいんだけど上手くいかない。

video.cuePointManager.addCuePoint({name:"cue_name",time:3});

・シークしたい
VideoDisplayには、シーク関連のメソッドが無い模様。
playheadTimeプロパティに任意の秒数を設定することでシークできた。

private function seek(p:Number):void{
video.playheadTime = video.totalTime*p;
}