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

时间:2012-11-28 17:29:54

标签: javascript jquery jsdoc

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

目前,我有这个:

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

但JSDoc无法识别(或正确格式化)“JQuery”作为变量类型。有什么帮助吗?

1 个答案:

答案 0 :(得分:35)

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

param name之前的Param类型。

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