引き続き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;
}
以上こんな感じですかね。