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
 */