Javascript 使用JSDoc+的模块和类;RequireJS+;BackboneJS
我正试图为我的系统创建一个文档,但总是有问题 在下面,我的类出现在模块MyModule中,完美!但是我的函数没有出现在文档中 你知道问题出在哪里吗Javascript 使用JSDoc+的模块和类;RequireJS+;BackboneJS,javascript,backbone.js,requirejs,jsdoc,Javascript,Backbone.js,Requirejs,Jsdoc,我正试图为我的系统创建一个文档,但总是有问题 在下面,我的类出现在模块MyModule中,完美!但是我的函数没有出现在文档中 你知道问题出在哪里吗 define([ 'underscore', 'backbone' ], function(_, Backbone) { 'use strict'; /** * MyModule * * @module MyModule */ var MyModule = {}; /** * Class description
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...
});
谢谢您必须在传递给
@lends
的名称前面加上模块名称。请参阅我根据您问题中的代码改编的剪贴本中的@lends
语句:
MyModule.View = Backbone.View.extend(
/** @lends module:MyModule.MyModule.View */
{
/**
* myFunction1
*
* @param {object} hello Hello World!
*/
myFunction1: function(hello) { }
});
有了上面的@lends
,我可以让myFunction1
显示出来,并有适当的文档记录