使用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) {};

我也在SO上找到了這個問題，有點類似：
如何讓JSDoc將我的param標記為jQuery對象？

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) {};

Answer 2

我也在github / js3doc上看到過 ：

@param {jQuery object} obj The jQuery object you're looking for.

或者github / js3doc

@param {module:jquery} jquery Some desc...