javascript generar ¿Cuál es la forma correcta de documentar un tipo de parámetro jQuery con JSDoc?




jsdoc npm (2)

Para un parámetro que es un objeto jQuery, a menudo simplemente hago:

@param {jQuery} foo

Y no defina aún más qué es jQuery. Se sabe bastante bien. Sin embargo, si lo desea, puede hacer esto con 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) {};

https://code.i-harness.com

Estoy tratando de documentar mi programa con la sintaxis de JSDoc para mí y para las personas que tendrán que mirar mi código. También estoy tratando de mejorar mis habilidades.

Para un parámetro del tipo jQuery, estoy un poco confundido. Sé que es un objeto, pero es bastante común en mi programa, así que creo que primero debería declarar un typedef para el tipo jQuery, luego usarlo como mi tipo de parámetro. Así que pregunto, ¿sería la forma correcta de hacerlo?

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

También encontré en SO esta pregunta, algo similar:
¿Cómo puedo hacer que JSDoc marque mi parámetro como un objeto jQuery?


También vi en github/js3doc :

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

o github/js3doc

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




jsdoc