如何在YuiDoc中记录重载方法?

时间:2013-06-06 13:42:20

标签: javascript yuidoc

假设我在类foo上有一个方法,使用方法bar接受所有可选参数,但如果参数和顺序发生更改,则方法的返回值会发生显着变化。

var foo = {

    bar: function (param1, param2) {
        if (typeof param1 === 'object' && param2) {
           //do something and return something
        }
        if (typeof param1 === 'boolean') {
           //do something a little different
        }
    }

}

如何在yuidoc中表示调用此方法的不同方法?

可选参数是可以的,但如果我把它全部放在那里,方法描述会变得有点长。

0 个答案:

没有答案