首页
学习
活动
专区
工具
TVP
发布
社区首页 >问答首页 >如何让JSDoc将我的参数标记为jQuery对象?

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

Stack Overflow用户
提问于 2012-11-29 01:29:54
回答 1查看 14.2K关注 0票数 31

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

目前,我有以下内容:

代码语言:javascript
复制
/**
 * Initializes a login object.
 * @param formEl {JQuery} The login form element on the page.
 */
var login = function(formEl){ ... }

但是JSDoc不能将"JQuery“识别(或正确格式化)为变量类型。有什么帮助吗?

EN

回答 1

Stack Overflow用户

回答已采纳

发布于 2012-11-29 02:36:16

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

Param type在param name之前。

代码语言:javascript
复制
/**
 * Initializes a login object.
 * @param {jQuery} formEl The login form element on the page.
 */
var login = function(formEl){ ... }
票数 42
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/13610979

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档