2014-01-21 111 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展现出来,适当的记录。