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에서 의미하는 바를 좀 더 구체적으로 설명해야 합니다. 이것은 자바스크립트를 위한 거의 모든 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