Wie kann ein Array von Objekten als Parameter oder Rückgabewert in JSDoc angegeben werden?

In JSDoc zeigt die beste Dokumentation, die ich finden kann, Folgendes, wenn Sie ein Array eines bestimmten Typs (z. B. ein Array von Zeichenfolgen) haben:

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

Wie würden Sie die folgenden Fragezeichen ersetzen, um ein Array von Objekten anzugeben?

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

Sie sollten genauer sagen, was Sie unter JSDoc verstehen - dies ist ein Oberbegriff, der so ziemlich alle Dokumentationstools im JavaDoc-Stil für JavaScript abdeckt.

Die Syntax, die Sie für ein Array von Zeichenfolgen verwendet haben, ähnelt der von Google Closure Compiler unterstützten .

Wenn Sie dies verwenden, wäre ein Array von Objekten:

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

Oder einfach nur eine Reihe von Dingen - dies sollte mit so ziemlich allen Doc-Tools funktionieren:

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

jsdoc-toolkit , JSDoc 3 und JSDuck unterstützen die folgende Syntax, um ein Array von Objekten zu kennzeichnen:

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

BEARBEITEN

Wenn Sie die Schlüssel und den Variablentyp der Werte kennen, können Sie auch Folgendes tun:

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

oder

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