150

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

1 回答 1

253

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

您用于字符串数组的语法类似于Google Closure Compiler支持的语法。

使用它,对象数组将是:

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

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

/**
 * @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
 */
于 2013-02-13T13:38:03.787 回答