当前在具有Dojo(1.10)和ESRI API Javascript的项目中使用Webstorm。
我有一个接受小部件(对象/类)的函数,但是由于JSDoc,Webstorm向我显示了一些警告。
码:
/**
* 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的“设置”功能。
我收到以下消息警告:“未解析的函数或方法set()”。
已经尝试了@name,@function(可能不是正确的方式)!
我知道这是可选的(只是警告),但是,我想以正确的方式记录所有内容。
那么,如何记录匿名对象/ dojo小部件的“设置”功能?
最佳答案
关于什么
/**
* A dojo widget (toolbar).
* @typedef {Object} ToolbarWidget
* @property {function} set
*/