-2

イベント ハンドラ パラメータにコメントするにはどうすればよいですか? つまり、イベント ハンドラのパラメータにコメントを付ける必要がありますか?

例：

TimerMessage クラスは Timer を拡張します。

TimerMessage クラスには setMessage メソッドがあり、パブリック var 'message' 内にテキスト メッセージを格納します。

使用中:

var timer_message:TimerMessage = new TimerMessage(1000, 1)
timer_message.setMessage('hello')
timer_message.addEventListener(TimerEvent.TIMER_COMPLETE, displayMessage)

private function displayMessage(e:TimerEvent):void{
txt.text = e.target.message
e.target.stop()
e.target.removeEventListener(TimerEvent.TIMER_COMPLETE, displayMessage)
}

displayMessage ハンドラにコメントするにはどうすればよいですか?

/* Displays message on main stage
 * @param e - timer event
 * */

そのように？

@param 部分が冗長すぎると思います。

あなたが思うこと？

ありがとう

4

1 に答える 1

1

いいえ、冗長すぎません。私は通常、記録したいメソッドや変数の前に Command-Shift-D を押します (Mac では、Windows では Command キーを Control キーに置き換えると思います)。

Flash Builder は、メソッド内の各引数の @param を含む、入力用のコメント テンプレートを生成します。

これは、 asdoc コマンドを使用してコードの見栄えの良い HTML ドキュメントに変換できます。その時点で、これらの冗長な @param はすべて冗長ではなくなり、実際にはかなりきれいに見えます。他にもタグあります。

于 2012-04-14T04:14:48.407 に答える