एएमडी + बैकबोन + JSDoc3 दस्तावेज करने का सबसे अच्छा तरीका

Question

मैं अपने कोड को दस्तावेज़ करने का सबसे अच्छा तरीका ढूंढ रहा हूं, लेकिन मुझे कुछ भी नहीं मिला।

मैंने this सहित अन्य विषयों को देखा है, लेकिन सभी मेरी समस्या का समाधान नहीं करते हैं।

मैं कुछ इस तरह है:

define([ 
    'backbone' 
], function (Backbone) { 

    /** 
    * @module models/products 
    */ 

    /** 
    * Product model 
    * @class 
    */ 
    var Product = Backbone.Model.extend({ 
     /** @lends Product.prototype */ 

     /** 
     * Some method 
     * @param {String} name - Name of something 
     * @return {something} 
     */ 

     someMethod: function() { 
      // ... 
     } 

    }); 

    /** 
    * Products collection 
    * @class 
    */ 
    var Products = Backbone.Collection.extend({ 
     /** @lends Products.prototype */ 

     /** 
     * @type {Product} 
     */ 
     model: Product, 


     /** 
     * Some method 
     * @param {String} name - Name of something 
     * @return {something} 
     */ 

     someMethod: function() { 
      // ... 
     } 

    }); 

    return Products; 

}); 

मैं एक स्पष्ट प्रलेखन उत्पन्न करने के लिए की जरूरत है, जहां उत्पाद और उत्पाद कक्षाएं मॉडल में apears/उत्पादों मॉड्यूल, लेकिन मैं मॉड्यूल स्पष्ट मिलता है और वर्ग अलग से।

मुझे लगता है कि कोई ऐसा व्यक्ति है जो इस मुद्दे से गुजर चुका है।

धन्यवाद।

पीडी 1: मैं वास्तव में अन्य पोस्ट पढ़ता हूं, मैं प्रश्नों को डुप्लिकेट करने की कोशिश नहीं कर रहा हूं।

PD2 क्षमा करें मेरी गरीब अंग्रेज़ी: एस

Answer 1

इस doc पढ़ने के बाद, मैं समझता हूँ कि आपकी समस्या को फ़ाइल के शीर्ष करने के लिए निम्न कोड का स्थान बदलना द्वारा हल किया जा कर सकते हैं:

/** 
* @module models/products 
*/ 

मैं समझता हूँ चूंकि आपने अज्ञात फ़ंक्शन के अंदर @module लिखा है, इसलिए इसे अनदेखा कर दिया गया है।