2014-01-21 113 views
2

我正在嘗試爲我的系統創建一個文檔,但事情總是錯誤的。使用JSDoc + RequireJS + BackboneJS的模塊和類

在下面,我的類出現在模塊MyModule中,完美!但是我的功能沒有出現在文檔中!

你知道問題來自哪裏嗎?

define([ 
    'underscore', 
    'backbone' 
], function(_, Backbone) { 
    'use strict'; 

/** 
* MyModule 
* 
* @module MyModule 
*/ 

var MyModule = {}; 

/** 
* Class description 
* 
* @class MyModule.View 
* @extends Backbone.View 
* @memberOf module:MyModule 
* @abstract 
*/ 

MyModule.View = Backbone.View.extend(

    /** @lends MyModule.View */ 

    { 

    /** 
    * myFunction1 
    * 
    * @param {object} hello Hello World! 
    */ 

    myFunction1: function(hello) { } 


    } 

}); 

/** 
* Class description 
* 
* @class MyModule.Model 
* @extends Backbone.Model 
* @memberOf module:MyModule 
* @abstract 
*/ 

MyModule.Model = Backbone.Model.extend(); 
    //etc... 
}); 

感謝

回答

1

你必須前綴傳遞給@lends與模塊名稱的名稱。請參閱本文檔片斷我適應你的問題從代碼中@lends聲明:

MyModule.View = Backbone.View.extend(
    /** @lends module:MyModule.MyModule.View */ 
    { 

    /** 
    * myFunction1 
    * 
    * @param {object} hello Hello World! 
    */ 
    myFunction1: function(hello) { } 
    }); 

通過上面的@lends,我能夠得到myFunction1展現出來,適當的記錄。