javascript - JSDoc中如何指定一个对象数组作为参数或返回值？

Question

在 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...
 }

Answer 1

您应该更具体地说明 JSDoc 的含义 - 这是一个通用术语，几乎涵盖了 JavaScript 的所有 JavaDoc 样式的文档工具。

您用于字符串数组的语法看起来像 Google Closure Compiler 支持的语法.

使用它，对象数组将是:

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

或者只是任何东西的数组——这应该适用于几乎所有的文档工具:

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

jsdoc-toolkit , JSDoc 3 , 和 JSDuck支持以下语法来表示对象数组:

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

---

编辑

如果您知道键和值的变量类型，您还可以这样做:

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

或

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