如何使用YUIDoc记录向量参数?

时间:2015-01-08 08:04:59

标签: javascript documentation yuidoc

知道如何使用YUIDoc记录方法参数,其中param是一个向量,是一个三元素的数字数组吗?

这就是我到目前为止所做的事情,将简介描述为"数组(数字)":

 /**
 * Sets the color, which is a three-element array of double-precision numbers.
 * @method setColor
 * @param value {Array(Number)}
 */
this.setColor(value) {
    //...
}

1 个答案:

答案 0 :(得分:1)

您可以像这样指定默认值。

/**
 * @method setColor
 * @param {Array} [value=[0.0, 0.0, 0.0]] `Array` of `Number`
 */
function setColor(value) {
}