RequireJS импортная документация

Question

Im использование в редакторе WebStorm. Мой проект использует RequireJS с AMD. Существует пример кода:

dep.js

define([], function() { 
var exports = { 
    helloWorld: function() { 
    console.log("Hello world"); 
    } 
}; 
return exports; 
}); 

primary.js

define(['dep'], function (dep) { 
var exports = { 
    sayHello: function() { 
     dep.helloWorld(); 
    } 
}; 
return exports; 
}); 

Как документировать должным образом экспорт (это в основном описано в других ответах) и (важный!) импорт таких модулей AMD, поэтому WebStorm может иметь правильные подсказки типа для импортированных отпечатков (например, переменная «dep» в этом примере).

Answer 1

Согласно AMD howto, она должна быть чем-л, как

/** 
* @module dep 
*/ 
define([], function() { 
    /** 
    * @constructor 
    * @alias module:dep 
    */ 
    var exports = { 
     helloWorld: function() { 
      console.log("Hello world"); 
     } 
    }; 
    return exports; 
});