YUIDocでメソッドのパラメーターがkey/valueペアの書き方

Pocket

YUIDocでkey/valueペアーのパラメーターの書き方のメモ。

YUIDoc – JavaScript Documentation Tool

/**
 * パラメーターがkey/valueペアの書き方
 *
 * @method exmaple
 * @param {Object} options key/valueペアー
 *   @params {String} options.key1 キー1です。
 *   @params {Number} options.key2 キー2です。
 */

コメント

No comments yet.

コメントの投稿

改行と段落タグは自動で挿入されます。
メールアドレスは表示されません。