@use JSDoc

语法

@mixes <OtherObjectPath>

概述

@mixes 标记表示当前对象混合了来自 OtherObjectPath 的所有成员，这是一个 @mixin。

示例

首先，我们使用 @mixin 标记记录一个 mixin

@mixin 示例
/**
 * This provides methods used for event handling. It's not meant to
 * be used directly.
 *
 * @mixin
 */
var Eventful = {
    /**
     * Register a handler function to be called whenever this event is fired.
     * @param {string} eventName - Name of the event.
     * @param {function(Object)} handler - The handler to call.
     */
    on: function(eventName, handler) {
        // code...
    },

    /**
     * Fire an event, causing all handlers for that event name to run.
     * @param {string} eventName - Name of the event.
     * @param {Object} eventData - The data provided to each handler.
     */
    fire: function(eventName, eventData) {
        // code...
    }
};

现在我们添加一个 FormButton 类，并调用一个“mix”函数，该函数将所有 Eventful 函数混合到 FormButton 中，以便 FormButton 也可以触发事件并拥有侦听器。我们使用 @mixes 标记来指示 FormButton 混合了 Eventful 函数。

使用 @mixes 标记
/**
 * @constructor FormButton
 * @mixes Eventful
 */
var FormButton = function() {
    // code...
};
FormButton.prototype.press = function() {
  this.fire('press', {});
}
mix(Eventful).into(FormButton.prototype);