AMD + Backbone + JSDoc3文檔的最佳途徑

我正在尋找記錄我的代碼的最佳方式，但我沒有找到任何東西。AMD + Backbone + JSDoc3文檔的最佳途徑

我已經看到其他主題，其中包括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到型號/產品模塊，但我得到的模塊清晰和課程分開。

我想有人經歷過這個問題。

謝謝。

PD1：我真的讀過其他帖子，我沒有試圖複製問題。

PD2：對不起我的英文不好：S

來源

2015-11-06 Exos

這種要求推薦工具和方式的方式被認爲是本網站的焦點話題。看看：http://stackoverflow.com/help/on-topic – mico

「我們覺得最好的堆棧溢出問題有一些源代碼，但如果你的問題一般涵蓋... [...] 常用軟件工具由程序員，並且是「，Wy你認爲它是關閉toppic？我要求正確使用「程序員常用的」工具。我沒有要求更好的使用，我要求正確使用。 – Exos

閱讀本doc後，我明白你的問題可以通過下面的代碼移動到文件的頂部來解決：

/** 
* @module models/products 
*/

我明白既然你已經寫了@module在一個匿名函數中，它就被忽略了。

來源

2015-11-18 05:19:27

任何人都可以驗證這是否是問題。主要作者是我猜。 –

不，如果我將「模塊」移動到文件頂部，我有沒有類的模塊，我試過了（如果您檢查我在描述中共享的線程），使用工廠的「借貸」而沒有結果。 – Exos

AMD + Backbone + JSDoc3文檔的最佳途徑

回答

相關問題