1. ホーム
  2. javascript

[解決済み] JSDocでオブジェクトの配列をパラメータや戻り値として指定する方法は?

2022-05-08 09:54:14

質問

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

解決方法は?

JSDocというのは、JavaScriptのためのJavaDocスタイルのドキュメントツールの総称で、もっと具体的に説明すべきです。

文字列の配列に使用された構文は、以下のものに似ています。 グーグルクロージャーコンパイラー .

これを使うと、Objectsの配列は、次のようになります。

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

あるいは、任意のものの配列。これは、ほとんどすべてのドキュメントツールで動作するはずです。

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

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

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


EDIT

キーと値の変数型がわかっている場合は、このようなことも可能です。

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

または

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