如何用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) {
}