Javascript-форум (https://javascript.ru/forum/)
-   Общие вопросы Javascript (https://javascript.ru/forum/misc/)
-   -   Документирование кода JSDoc (https://javascript.ru/forum/misc/65118-dokumentirovanie-koda-jsdoc.html)

mlounge 27.09.2016 19:29

Документирование кода JSDoc
 
Привет!

Мне необходимо задокументировать несколько модулей и объединить их в единую документацию при помощи JSDoc, но как это сделать не очень пойму.

Вот пример модуля:

// Module myModule1
(function() {

var instances = [];
function getInstance() { ... }
function createInstance() { 
   // Class MyModuleClass
   return {
       objParam1: ...,
       objMethod1: function() { ... }
   }
}

window.myModules.myModule1 = {
   instances: instances,
   createInstance: createInstance,
   getInstance: getInstance
}

})();


Вот проблемы:
1) JSDoc не хочет документировать то, что внутри (function() {})()
2) Надо объяснить JSDoc'у, что window.myModule1 - это модуль, а анонимный класс внутри create - собственно сам класс. Надо чтобы он бил документацию по разделам-модулям, а уже там показывал список классов.

Не мог ли кто-нибудь предложить пример аннотаций JSDoc для данного кода?


Часовой пояс GMT +3, время: 16:54.