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

在JSDoc中，我可以find最好的文档，如果你有一个特定types的数组（比如一个string数组），可以使用下面的代码：

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

你将如何replace下面的问号指定一个对象数组？

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

Answer 1

你应该更具体地指出JSDoc的含义 – 这是一个通用的术语，涵盖了几乎所有JavaDoc风格的JavaScript文档工具。

您用于string数组的语法看起来像Google Closure Compiler支持的语法。

使用这个，一个对象数组将是：

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

或者只是一些任何东西 – 这应该几乎所有的文档工具：

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

jsdoc-toolkit ， JSDoc 3和JSDuck支持以下语法来表示一个对象数组：

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

---

编辑

如果您知道键的值和variablestypes，您也可以这样做：

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

要么

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