Какой правильный способ документировать тип параметра jQuery с помощью jsDoc

Я пытаюсь документировать свою программу синтаксисом jsdoc для себя и людей, которым придется смотреть на мой код. Я также пытаюсь улучшить свои навыки. Для параметра типа jQuery я немного озадачен. Я знаю, что объект, но довольно распространенный в моей программе, поэтому я должен сначала объявить typedef для типа jQuery, а затем использовать его как мой тип параметра. Поэтому я спрашиваю, будет ли это правильным способом?

    /**
     * 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 для отметки моего параметра как объекта jquery?

Ответ 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) {};

Ответ 2

Я также видел на github/js3doc:

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

или github/js3doc

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