Как я могу сообщить 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, в которой может быть больше информации, чем на этой странице.