javascript - 使用 JSDoc 记录 Backbone 构造函数？

Question

我的应用程序有一个基本 View 方法，它有一个关闭方法。在我必须记录它之前，它一直很好用；基本上我是为了正确地记录它而进行了不必要的函数调用。由于 Backbone 已经有一个初始化函数，在这里再次调用它是没有意义的，占用代码行..但是如果我从代码中删除这个函数，那么就不会生成 View 的文档。我的代码如下所示:

/**
 * @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();
            }
        }
    });
});

This question通过记录让我走上了正确的轨道，但现在我想知道是否可以在 JSDoc 中记录初始化方法是从 Backbone.View 继承的，而不是编写函数调用。

如果有人能指出正确的方向，我将不胜感激。谢谢。

Answer 1

以下是否符合您的要求？我刚刚删除了 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();
            }
        }
    });
});