javascript - 如何使用 YUIDoc 记录矢量参数？

Question

知道如何使用 YUIDoc 记录方法参数，其中参数是一个向量，是一个三元素数字数组？

这就是我到目前为止所做的，将参数描述为简单的“Array(Number)”:

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

Answer 1

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

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