yuidoc - 重用复杂@param {Object}

时间:2013-08-22 14:54:03

标签: javascript documentation yuidoc

我有一个传递的Foo对象。

/**
 * Do something cool
 * 
 * @method baz
 * @param {Object} foo
 *     @param {String} foo.name
 *     @param {Number} foo.x
 *     @param {Number} foo.y
 *     @param {Number} foo.z
 */
Bar.prototype.baz = function (foo) { /* ... */ };

我的foo对象要大得多,我不想为我记录的每一个方法重复这个。我也不想每次Foo的结构发生变化时都要更新100个方法。

有没有办法单独声明Foo对象结构(ala a type?)然后从@param标签引用它。

0 个答案:

没有答案