我正在尝试使用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上发现了这个问题，有点类似:
How can I get JSDoc to mark my param as a jQuery object?
最佳答案
对于作为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) {};
关于javascript - 用JSDoc记录jQuery参数类型的正确方法是什么？，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/20252301/