2015-01-08 2 views
0

Любая идея документировать параметр метода с помощью YUIDoc, где param является вектором, являющимся трехэлементным массивом чисел?Как документировать векторный параметр с помощью YUIDoc?

Это то, что я делал до сих пор, описывая параметров, как просто «Array (номер)»:

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

ответ

1

Можно указать значение по умолчанию, как это.

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

Да, это кажется разумным обходным путем, по крайней мере, информация есть. Ура! (PS. Обратите внимание, что я случайно предоставил разметку для свойства и отредактировал, чтобы показать разметку для метода, который был тем, чем я был, но ваше решение по-прежнему применяется) – xeolabs