@use JSDoc

構文

@mixin [<MixinName>]

概要

ミックスインは、他のオブジェクトに追加することを目的とした機能を提供します。必要な場合は、@mixin タグを使用してオブジェクトがミックスインであることを示すことができます。その後、ミックスインを使用するオブジェクトに @mixes タグを追加できます。

例

@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...
    }
};