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

Question

我试图彻底评论我的JavaScript,我正在使用JSDoc.我有一个消耗jQuery对象的函数,我想将参数标记为这样.

目前,我有这个:

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

但JSDoc无法识别(或正确格式化)"JQuery"作为变量类型.有帮助吗？

Answer 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){ ... }