[解決済み] 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
*/
関連
-
[解決済み】JavaScriptの配列でforEachが関数でない不具合
-
[解決済み】Node.js Error: Cannot find module express
-
[解決済み] 配列から特定の項目を削除するにはどうすればよいですか?
-
[解決済み] JavaScript で配列に値が含まれているかどうかを確認するにはどうすればよいですか?
-
[解決済み] 配列に特定のインデックスで項目を挿入する方法 (JavaScript)
-
[解決済み] 2つのJavaScriptオブジェクトのプロパティを動的にマージするにはどうすればよいですか?
-
[解決済み] 配列を値でコピーする
-
[解決済み】オブジェクトの配列を文字列のプロパティ値でソートする
-
[解決済み】配列に何かを追加する方法は?
-
[解決済み】JavaScriptの関数にデフォルトのパラメータ値を設定する
最新
-
nginxです。[emerg] 0.0.0.0:80 への bind() に失敗しました (98: アドレスは既に使用中です)
-
htmlページでギリシャ文字を使うには
-
ピュアhtml+cssでの要素読み込み効果
-
純粋なhtml + cssで五輪を実現するサンプルコード
-
ナビゲーションバー・ドロップダウンメニューのHTML+CSSサンプルコード
-
タイピング効果を実現するピュアhtml+css
-
htmlの選択ボックスのプレースホルダー作成に関する質問
-
html css3 伸縮しない 画像表示効果
-
トップナビゲーションバーメニュー作成用HTML+CSS
-
html+css 実装 サイバーパンク風ボタン