javascript - 如何让 JSDoc 将我的参数标记为 jQuery 对象?

标签 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”识别(或正确格式化)为变量类型。有什么帮助吗?

最佳答案

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

关于javascript - 如何让 JSDoc 将我的参数标记为 jQuery 对象?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/13610979/

相关文章:

javascript - ReactJS:仅更新嵌套状态对象中的特定字段

javascript - PolyLine 腿的单独着色

javascript - 从 leaflet.js 映射中添加/删除 L.control

javascript - 在 fabric.js 中用颜色填充图像

javascript - 按升序/降序动态地将 z-index 分配给具有特定类别的未知数量的元素

折叠式菜单的 JavaScript 代码

javascript - 使用 jsdoc3 记录模块和子模块

node.js - 创建 NPM 包,如何记录它们?

javascript - 模板化对象的 JSDoc 对象

javascript - 如何使用 Javascript 检查视频文件中的音频?