Jak mogę udokumentować typ w webstormu używając tylko jsdoc?

Question

Kiedy piszę poniższego kodu spowoduje adnotator mówi mi, że BrowserSelector nie jest zdefiniowana w drugim typedef:

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

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

Uważam, że nie jest skojarzenie typu z nazwą. Jak mogę to zrobić?

Wolałbym nie dodawać rzeczywistego kodu, tylko komentarze jsdoc.

Answer 1

Używam tego komentarza styl 'struktury' podobnego rodzaju:

/** 
* @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

Niedawno zauważyłem w kodzie źródłowym AngularJS, że również opisywały rzeczy bez żadnego bezpośrednio dołączonego kodu. Próbowałem tę samą zasadę w danej sprawie i wpadł na następujący (nawet Podpowiedzi i wpisz sprawdzanie prac z nim 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

wielu komentarzy do opisania właściwości nie jest konieczne, ponieważ od Webstorm 7 (być może wcześniej).

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