Как я могу документировать тип в webstorm, используя только jsdoc?

Question

Когда я пишу следующий код, комментатор говорит мне, что BrowserSelector не определена во втором ЬурейеГо:

/** 
* @typedef {{name: String, minVer: Number, maxVer: Number}} BrowserSelector 
*/ 

/** 
* @typedef {{type:String, browser: BrowserSelector, attribute: Object}} Selector 
*/ 

Я считаю, что это не связывая типа с именем. Как я могу это сделать?

Я бы предпочел не добавлять к нему фактический код, просто комментарии jsdoc.

Answer 1

Я использую этот комментарий стиль '' структуры как типы:

/** 
* @name BrowserSelector 
* @property {String} name 
* @property {Number} minVer 
* @property {Number} maxVer 
*/ 

/** @type {BrowserSelector|*} */ 
var mySelector = {}; // no warning because of '*' in @type :S 
mySelector.name = 'foo'; // no warning :) 
mySelector.id = 'bar'; // warning :) 

Answer 2

Недавно я заметил в исходном коде AngularJS, что они также аннотировали материал без какого-либо непосредственно прикрепленного кода. Я попробовал один и тот же принцип, по вашему делу и пришли к следующему (даже код-завершения и проверки типов работы с ней в WebStorm):

/** 
* @name BrowserSelector 
*/ 
/** 
* @name BrowserSelector#name 
* @type {string} 
*/ 
/** 
* @name BrowserSelector#minVer 
* @type {number} 
*/ 
/** 
* @name BrowserSelector#maxVer 
* @type {number} 
*/ 

/** 
* @name Selector 
*/ 
/** 
* @name Selector#type 
* @type {string} 
*/ 
/** 
* @name Selector#browser 
* @type {BrowserSelector} 
*/ 
/** 
* @name Selector#attribute 
* @type {Object} 
*/ 

Answer 3

Несколько замечаний для описания свойств не требуется, поскольку из WebStorm 7 (возможно, ранее).

/** 
* @name BrowserSelector 
* @type {{ 
*  name: String, 
*  minVer: Number, 
*  maxVer: Number 
* }} 
*/