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

内容来源于 Stack Overflow,并遵循CC BY-SA 3.0许可协议进行翻译与使用

  • 回答 (1)
  • 关注 (0)
  • 查看 (141)

我试图彻底地注释我的javascript,并且使用JSDoc。我有一个函数,它使用jQuery对象,我想将参数标记为这样。

目前我有这样的想法:

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

但JSDoc无法将JQuery识别(或正确格式化)为变量类型。

提问于
用户回答回答于

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

参数名称前的参数类型。

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

扫码关注云+社区

领取腾讯云代金券