假设我有一个类 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 中调用此方法的不同方式?
可选参数没问题,但是如果我把它都放在那里,方法描述会有点长。