@use JSDoc

語法

@mixes <OtherObjectPath>

概觀

@mixes 標籤表示目前的物件會混合來自 OtherObjectPath 的所有成員，而 OtherObjectPath 是 @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);