javascript typedef - 如何在JSDoc中指定對像數組作為參數或返回值?





documentation (2)


您應該更具體地了解JSDoc的含義 - 這是一個涵蓋JavaScript的幾乎所有JavaDoc樣式文檔工具的通用術語。

您用於字符串數組的語法類似於Google Closure Compiler支持的語法。

使用它,一個對像數組將是:

/**
 * @param {Array.<Object>} myObjects
 */

或者只是一系列的東西 - 這應該適用於幾乎所有的doc工具:

/**
 * @param {Array} myArray
 */

jsdoc-toolkitJSDoc 3JSDuck支持以下語法來表示對像數組:

/**
 * @param {Object[]} myArray
 */

編輯

如果你知道值的鍵和變量類型,你也可以這樣做:

/**
 * @param {Array.<{myNumber: Number, myString: String, myArray: Array}>} myObjects
 */

要么

/**
 * @param {{myNumber: Number, myString: String, myArray: Array}[]} myObjects
 */

在JSDoc中,如果您有一個特定類型的數組(例如字符串數組),我可以找到的最佳文檔顯示使用以下內容:

/**
 * @param {Array.<string>} myStrings All my awesome strings
 */
 function blah(myStrings){
     //stuff here...
 }

如何替換下面的問號指定一個對像數組?

/**
 * @param {???????} myObjects All of my equally awesome objects
 */
 function blah(myObjects){
     //stuff here...
 }



框架免費,有限但輕

var d = (new Date()+'').split(' ');
// ["Tue", "Sep", "03", "2013", "21:54:52", "GMT-0500", "(Central", "Daylight", "Time)"]

[d[3], d[1], d[2], d[4]].join(' ');
// "2013 Sep 03 21:58:03"




javascript documentation jsdoc