JSDoc에서 매개 변수 또는 반환 값으로 객체 배열을 지정하는 방법은 무엇입니까?

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

---

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

참고 URL : https://stackoverflow.com/questions/14611995/how-to-specify-an-array-of-objects-as-a-parameter-or-return-value-in-jsdoc