web-dev-qa-db-ja.com

JSDocでパラメーターまたは戻り値としてオブジェクトの配列を指定する方法は？

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...
 }
javascriptdocumentationjsdoc
81
Ray

JSDocの意味をより具体的にする必要があります。これは、JavaScriptのJavaDocスタイルのドキュメントツールをほぼすべて網羅する一般的な用語です。

文字列の配列に使用した構文は、 Google Closure Compiler でサポートされている構文に似ています。

これを使用すると、オブジェクトの配列は次のようになります。

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

または、ただの配列-これはほとんどすべてのdocツールで動作するはずです：

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

jsdoc-toolkit 、 JSDoc 、および JSDuck は、オブジェクトの配列を示す次の構文をサポートしています。

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

編集

キーと値の変数タイプがわかっている場合は、次のこともできます。

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

または

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