JSDoc에 반환되는 객체의 구조에 대해 어떻게 알 수 있습니까? @return {{field1: type, field2: type, ...}} description
구문 을 찾아서 시도했습니다.
/**
* Returns a coordinate from a given mouse or touch event
* @param {TouchEvent|MouseEvent|jQuery.Event} e
* A valid mouse or touch event or a jQuery event wrapping such an
* event.
* @param {string} [type="page"]
* A string representing the type of location that should be
* returned. Can be either "page", "client" or "screen".
* @return {{x: Number, y: Number}}
* The location of the event
*/
var getEventLocation = function(e, type) {
...
return {x: xLocation, y: yLocation};
}
이것이 성공적으로 구문 분석되는 동안 결과 문서는 다음과 같이 간단히 나타납니다.
Returns:
The location of an event
Type: Object
API를 개발 중이며 사람들이 반환 할 객체에 대해 알아야합니다. JSDoc에서 가능합니까? JSDoc3.3.0-beta1을 사용하고 있습니다.
@typedef
해결 방법 / 솔루션 이라는 것을 알고 있지만 리터럴 객체에서 작동하지 않는 것은 이상하게 보입니다. 누군가 내가 미래 에이 문제를 우연히 발견한다면 이 페이지보다 더 많은 정보를 가질 수있는 github.com/jsdoc/jsdoc/issues/1678 문제를 추가했습니다 .