用JSDoc记录一个Backbone构造函数？
我有我的应用程序有一个密切的方法的基本视图方法。 它工作良好，直到我必须记录它为止。 基本上我正在进行一个不必要的函数调用，以便正确记录它。 因为Backbone已经有了一个初始化函数，所以在这里再次调用它是没有意义的，占用代码行......但是如果我从代码中删除这个函数，那么不会生成视图的文档。 我的代码如下所示：
/**
* @exports BaseView
*/
define(['backbone'], function( Backbone ) {
'use strict';
return Backbone.View.extend( /** @lends BaseView.prototype */ {
/**
* Base view with close method
* @exports BaseView
* @augments Backbone.View
* @constructor
*/
initialize: function() {
Backbone.View.prototype.initialize.call(this);
},
/**
* Removes the view from the DOM and unbinds all events.
*/
close: function() {
this.remove();
this.unbind();
if (this.onClose) {
// Optionally, run additional cleanup methods.
this.onClose();
}
}
});
});
这个问题让我在记录的正确轨道上，但现在我想知道是否有可能在JSDoc中记录initialize方法是从Backbone.View继承而不是编写函数调用。
如果有人能指出我正确的方向，将不胜感激。 谢谢。
以下是否做你想要的？ 我刚刚删除了initialize函数，将@name BaseView添加到它前面的doclet中，并删除了@exports ... ，这是在同一个doclet中，因为它在那里似乎不正确。
/**
* @exports BaseView
*/
define(['backbone'], function( Backbone ) {
'use strict';
return Backbone.View.extend( /** @lends BaseView.prototype */ {
/**
* Base view with close method
* @augments Backbone.View
* @constructor
* @name BaseView
*/
/**
* Removes the view from the DOM and unbinds all events.
*/
close: function() {
this.remove();
this.unbind();
if (this.onClose) {
// Optionally, run additional cleanup methods.
this.onClose();
}
}
});
});