返されるオブジェクトの構造を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を。