正确使用JSDoc与此对象的匿名对象和函数的方法

时间:2016-04-27 12:53:37

标签: javascript dojo widget webstorm jsdoc

目前在使用Dojo(1.10)和ESRI API Javascript的项目中使用Webstorm。

我有一个接受Widget(Object / Class)的函数,但Webstorm因为JSDoc而向我显示一些警告。

代码:

/**
 * Init toolbar
 *
 * @param {Object} [options] - Toolbar options
 * @param {string} [options.title=Default title] - Main title
 * @param {ToolbarWidget} toolbarObj - Toolbar widget to set
 */
initToolbar: function(options, toolbarObj) {
  ...
  toolbarObj.set('title', _title);
}

第一个警告是在' toolbarObj '上。我收到一条消息' Unresolved variable or type '。

这很容易解决。刚刚包含以下JSDoc:

/**
 * A dojo widget (toolbar).
 * @typedef {Object} ToolbarWidget
 */

现在,另一个警告是toolbarObj的' set '功能。 我收到以下消息的警告:'未解析的函数或方法集()'。

已经尝试@name,@ function(可能没有以正确的方式)!

我知道这是可选的(只是一个警告),但是,我喜欢以正确的方式记录所有内容。 那么,我如何记录匿名对象/ dojo小部件的'set'函数?!

1 个答案:

答案 0 :(得分:1)

怎么样?
/**
 * A dojo widget (toolbar).
 * @typedef  {Object} ToolbarWidget
 * @property {function} set 
 */