Как я могу сообщить 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, в которой может быть больше информации, чем на этой странице.Ответы:
Определите свою структуру отдельно, используя @typdef :
/** * @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}; }
источник
@return
операторов действительно работают, но они перечислены в выходных данных, как если бы они были несколькими возвратами (один пункт указывает,point - Object
а затем два других пункта дляpoint.x - Number
иpoint.y - Number
). Хотя я могу с этим жить, я полагаю, что нет возможности получить сжатый вывод возвращенного объекта? Или, по крайней мере, иметь записи дляpoint.x
и сpoint.y
отступом?@typedef
подход является наиболее понятным с точки зрения вывода документации, спасибо!@inner
или ввести определениеglobal
в документации. +1@typedef {Object} Point
. Фактически, использование этой двухстрочной формы выделяетPoint
в PhpStorm сообщение «Неразрешенная переменная или тип Point». В@typedef
документах поддерживают это, но я не хочу , чтобы изменить этот ответ , если это допустимый вариант.В качестве альтернативы уже опубликованным предложениям вы можете использовать этот формат:
/** * 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.
источник
Чистое решение - написать класс и вернуть его.
/** * @class Point * @type {Object} * @property {number} x The X-coordinate. * @property {number} y The Y-coordinate. */ function Point(x, y) { return { x: x, y: y }; } /** * @returns {Point} The location of the event. */ var getEventLocation = function(e, type) { ... return new Point(x, y); };
источник
Point
не является конструктором, чтобы изменить это, замените телоPoint
функции наthis.x = x; this.y = y;
new
синтаксис заключается в создании экземпляра изconstructor
. Безnew
контекстаthis
был бы глобальный контекст. Вы можете попробовать создать экземпляр,new
чтобы не увидеть эффекта.