14

次のような配列があります。

[{
    "name": "c917379",
    "email": "jim@bmw.de"

},
{
    "name": "c917389",
    "email": "jane@bmw.de"
}]

これは、多数の繰り返しフィールドを持つ任意の長さの配列です (わかりやすくするために、これを 2 つのフィールドに減らしました)。これは JavaScript メソッドに渡されます。

/**
 * @param {?}  data
 */
update:  function(data) {...}

これを JSDoc でどのように文書化するのだろうと思っていました。すなわち。疑問符があるタイプをどのように文書化しますか?

4

4 に答える 4

28

JSDocには、 typeのメンバーを持つ配列の例がありMyClassます。次のようになります。

@param {Array.<MyClass>}

したがって、次のようにすることもできます。

@param {Array.<Object>}

そして、これも理にかなっています：

@param {Array.<{name:string, email:string}>}
于 2014-04-01T13:24:43.923 に答える
23

私は自分の質問に対する答えを見つけました：

次のようになります。

/**
 *
 * @param {{name:string, email:string}[]}  
 *
 */
于 2013-06-18T08:40:38.990 に答える
10

オブジェクトのコンテンツには本質的に「特別な」ものは何もないので、次のように宣言するだけでよいと思います。

@param {Object[]} data

別の方法は、「クラス」の「適切な」コンストラクター関数を宣言し、Objectその関数名に置き換えることです。

このカプセル化は、コードの他の部分にも役立つ場合があります ;-)

于 2013-06-18T08:36:32.913 に答える