JsDoc Toolkitを使う！
@event
最終更新：
aias-jsdoctoolkit
トップページ > ドックコメントの書き方 > タグリファレンス >
@event
@eventタグは、自分と同じ名前を持つイベントが発生したときに実行することができる関数について記述します。
構文
@event
- @eventタグの構文は@functionタグと同一です。
例
シンプルに関数をイベントとしてタグ付けできます。
Cocktail.prototype.stir = function(clockwise) {
}
あるいはコード内の関数定義を参照せず、@nameタグを使うこともできます。
/**
*
@name
Cocktail#shake
*
@event
*
@param
{MyEventObject} e
*
@param
{Boolean} [e.withIce=false]
*/
イベントの参照
上に示したような名前付きドックコメントのネームパスを参照する場合、同じ名前を持つメソッドとイベントを区別できない可能性がある点に注意してください。（メソッドとイベントの）どちらを参照しているのか明確にするには、イベントを指すネームパスのイベント名の前にプリフィックス"event:"を付けてください。
Cocktail#event:shake
ネームパスによってイベントを参照する必要がある場合、名前は下のようにevent:name形式で表記すべきです。
/**
*
@constructor
*
@borrows
Cocktail#event:shake as this.event:shake
*/
function MilkShake() {
}
/**
* @event
* @param {Boolean} clockwise
*/