[英]How to document a vector param with YUIDoc?
任何想法如何用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) {
//...
}
您可以像這樣指定默認值。
/**
* @method setColor
* @param {Array} [value=[0.0, 0.0, 0.0]] `Array` of `Number`
*/
function setColor(value) {
}
聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.