如何将返回的对象的结构告诉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,该信息可能比此页面更多。