如何让 JSDoc 将我的参数标记为 jQuery 对象？

【问题标题】：How can I get JSDoc to mark my param as a jQuery object?如何让 JSDoc 将我的参数标记为 jQuery 对象？
【发布时间】：2012-11-16 15:40:01
【问题描述】：

我正在尝试彻底评论我的 JavaScript，并且我正在使用 JSDoc。我有一个使用 jQuery 对象的函数，我想将参数标记为这样。

目前，我有这个：

/**
 * Initializes a login object.
 * @param formEl {JQuery} The login form element on the page.
 */
var login = function(formEl){ ... }

但 JSDoc 无法将“JQuery”识别为（或正确格式化）变量类型。有什么帮助吗？

【问题讨论】：

【解决方案1】：

根据http://code.google.com/p/jsdoc-toolkit/wiki/TagParam应该是

参数名称前的参数类型。

/**
 * Initializes a login object.
 * @param {jQuery} formEl The login form element on the page.
 */
var login = function(formEl){ ... }

【讨论】：

做到了。我认为它必须是一些简单的东西......谢谢！
通常（至少在我见过的代码中）类型是jQuery 以匹配导出的全局变量的名称。
按照惯例，在 JQuery 对象前加上 $ 会很有帮助。这样大家就知道$formEl 是对元素的JQuery 引用。
@param {JQuery} 应为 @param {jQuery}，并带有小写 j。
@LoopDuplicate VSCode 告诉我jQuery 是$ 后面的对象，用于选择元素。而JQuery则是$(...)返回的元素集对象。