javascript - 使用 JSDoc 记录 jQuery 参数类型的正确方法是什么？

Question

我正在尝试使用 JSDoc 语法为我自己和必须查看我的代码的人记录我的程序。我也在努力提高自己的技能。

对于一个jQuery类型的参数，我有点疑惑。我知道这是一个对象，但它在我的程序中相当常见，所以我想我应该首先为 jQuery 类型声明一个 typedef，然后将其用作我的参数类型。所以我问，这是正确的方法吗？

/**
 * DOM object referenced by jQuery
 * @typedef {jQuery} $jQueryDomObject
 */

/**
* SOAP call that does ...
*
* @param {string} code Some desc ...
* @param {callback} fnctVa Some desc ...
* @param {$jQueryDomObject} $attrib Input field that ...
*/
myfunction = function (code, fnctVa, $attrib) {};

我还发现了这个问题，有点类似:
How can I get JSDoc to mark my param as a jQuery object?

Answer 1

对于 jQuery 对象的参数，我经常这样做:

@param {jQuery} foo

并且不要进一步定义 jQuery 是什么。这是众所周知的。但是，如果您愿意，可以使用 jsdoc 3 执行此操作:

/**
 * jQuery object
 * @external jQuery
 * @see {@link http://api.jquery.com/jQuery/}
 */

/**
 * SOAP call that does ...
 *
 * @param {string} code Some desc ...
 * @param {callback} fnctVa Some desc ...
 * @param {external:jQuery} $attrib Input field that ...
 */
var myfunction = function (code, fnctVa, $attrib) {};