2016-04-27 81 views
0

当前在具有Dojo(1.10)和ESRI API Javascript的项目中使用Webstorm。使用带有匿名对象和此对象的函数的JSDoc的正确方法

我有一个接受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'。我收到一条消息'未解决的变量或类型'。

这很容易解决。只是包括以下JSDoc:

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

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

已经试过@name,@function(可能不是正确的方式)!

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

回答

1

什么

/** 
* A dojo widget (toolbar). 
* @typedef {Object} ToolbarWidget 
* @property {function} set 
*/ 
+1

谢谢!有用! –