如何告诉JSDoc返回的对象的结构。我已经找到了@return {{field1: type, field2: type,…}}描述语法,并尝试它:
/**
* 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单独定义你的结构:
/**
* @typedef {Object} Point
* @property {number} x - The X Coordinate
* @property {number} y - The Y Coordinate
*/
并使用它作为返回类型:
/**
* 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 {Point}
* The location of the event
*/
var getEventLocation = function(e, type) {
...
return {x: xLocation, y: yLocation};
}
除了已经发布的建议,你可以使用下面的格式:
/**
* Get the connection state.
*
* @returns {Object} connection The connection state.
* @returns {boolean} connection.isConnected Whether the authenticated user is currently connected.
* @returns {boolean} connection.isPending Whether the authenticated user's connection is currently pending.
* @returns {Object} connection.error The error object if an error occurred.
* @returns {string} connection.error.message The error message.
* @returns {string} connection.error.stack The stack trace of the error.
*/
getConnection () {
return {
isConnected: true,
isPending: false,
error
}
}
它将给出以下文档输出:
Get the connection state.
getConnection(): Object
Returns
Object: connection The connection state.
boolean: connection.isConnected Whether the authenticated user is currently connected.
boolean: connection.isPending Whether the authenticated users connection is currently pending.
Object: connection.error The error object if an error occurred.
string: connection.error.message The error message.
string: connection.error.stack The stack trace of the error.