2013-06-15 4 views
6

मैं JSDoc3 कोड है कि इन पंक्तियोंकैसे JSDoc3 उपयोग करने के लिए नेस्टेड नामस्थान

/** 
* @namespace MyNamespace.MySubNamespace 
*/ 

(function (MyNamespace) { 
    MyNamespace.MySubNamespace.Foo = { 
     doSomething: function (someParam) { 
      // doing it 
     } 
    } 
})(window.MyNamespace) 

मैं JSDoc3 कैसे प्रयोग करेंगे दस्तावेज़ के लिए कि MyNamespaceMySubNamespace जो Foo शामिल होता है के साथ संरचित है दस्तावेज़ के लिए का उपयोग कर समस्या हो रही है दस्तावेज़ के लिए? आगे मैं doSomethingFoo के साथ कैसे जोड़ूं और इसके पैरामीटर someParam को दस्तावेज़ित करूं?

मेरे पास एक सीमा है कि मैं उस फ़ाइल में दस्तावेज़ नहीं जोड़ सकता जिसमें MyNamespace और MySubNamespace घोषित किए गए हैं।

बहुत बहुत धन्यवाद!

उत्तर

17

यह पता लगाया। उम्मीद है कि यह समाधान दूसरों की मदद करता है।

/** 
* @namespace MyNamespace.MySubNamespace 
*/ 

(function (MyNamespace) { 
    /** 
     * Foo namespace 
     * @namespace Foo 
     * @memberOf MyNamespace.MySubNamespace 
     */ 
    var Foo = { 
     /** 
      * Does something. 
      * @memberOf MyNamespace.MySubNamespace.Foo 
      * @param {object} someParam Some parameter. 
      */ 
     doSomething: function (someParam) { 
      // doing it 
     } 
    }; 
    MyNamespace.MySubNamespace.Foo = Foo; 
})(window.MyNamespace)  
संबंधित मुद्दे