2015-09-01 7 views
0

Я пытаюсь получить пространство имен для работы с шаблоном раскрывающего модуля. У меня есть код, который выглядит примерно следующим образом:Jsdoc namespacing с раскрывающимся шаблоном модуля

/** 
* @namespace bigpage 
*/ 
var bigpage = {}; 

/** 
* @namespace bigpage.data.methods 
* @memberOf bigpage.data 
*/ 

bigpage.data.methods = bigpage.data.methods || (function() { 
    /** 
    * @function 
    * @memberOf bigpage.data.methods 
    * @param {string} 
    */ 
    function getDataSeller(method) { 
    } 
    return { getDataSeller : getDataSeller }; 
})(); 

Однако JSDoc не видя, чтобы забрать документацию getDataSeller. Если бы кто-то мог дать мне способ сделать это, а также причину, почему вышеупомянутое не работает, это было бы здорово.

ответ

1

Я нашел эту ссылку, чтобы быть очень полезным: http://devnull.absolventa.de/2014/03/25/jsdoc-and-the-revealing-module-pattern/

// In file: namespace.js 
(function() { 
    window.Absolventa = window.Absolventa || {}; 
}()); 

// In file: modules/urlify.js 
(function() { 
    "use strict"; 
    Absolventa.Urlify = (function() { 
     var init; 

     /** 
     * @param {string} foo 
     */ 
     init = function(foo) { 
      // Magick! 
     }; 

     return { 
      init : init 
     }; 
    }()); 
}()); 

До сих пор мы видим некоторые предварительные успех. Мне еще предстоит полностью реализовать его во всем нашем коде, но я использовал его на нашем самом вложенном коде и, похоже, работает (с использованием JSDoc3)

+0

Хотя это теоретически может ответить на вопрос, [было бы предпочтительнее ] (// meta.stackoverflow.com/q/8259), чтобы включить здесь основные части ответа и предоставить ссылку для справки. – Tunaki