如何获取JSDoc将我的参数标记为jQuery对象? [英] How can I get JSDoc to mark my param as a jQuery object?

问题描述

我正在尝试对JavaScript进行彻底注释，并且正在使用JSDoc.我有一个使用jQuery对象的函数，我想这样标记参数.

I'm attempting to thoroughly comment my JavaScript and I'm using JSDoc. I have a function that consumes a jQuery object and I'd like to mark the parameter as such.

当前，我有这个:

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

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

But JSDoc doesn't recognize (or properly format) "JQuery" as a variable type. Any help?

推荐答案

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

参数名称前的参数类型.

Param type before param name.

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

这篇关于如何获取JSDoc将我的参数标记为jQuery对象?的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！