Comment puis-je informer JSDoc de la structure d'un objet renvoyé. J'ai trouvé la @return {{field1: type, field2: type, ...}} description
syntaxe et l' ai essayé:
/**
* 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};
}
Bien que cette analyse réussisse, la documentation qui en résulte indique simplement:
Returns:
The location of an event
Type: Object
Je développe une API et j'ai besoin que les gens sachent l'objet qu'ils recevront. Est-ce possible dans JSDoc? J'utilise JSDoc3.3.0-beta1.
@typedef
c'est une solution de contournement / solution, mais il semble étrange que cela ne fonctionne pas avec des objets littéraux. Si quelqu'un tombe sur cela à l'avenir (comme je l'ai fait), j'ai ajouté un problème github.com/jsdoc/jsdoc/issues/1678 qui pourrait avoir plus d'informations que cette page.