@use JSDoc

語法

@exports <moduleName>

在 JSDoc 3.3.0 及後續版本中，<moduleName> 可以包含 module: 前綴。在先前版本中，您必須省略此前綴。

概觀

在記錄輸出任何項目（除了「exports」物件或「module.exports」屬性）的 JavaScript 模組時，請使用 @exports 標籤。

範例

在使用特殊「exports」物件的模組中，永遠不需要 @exports 標籤。JSDoc 會自動辨識此物件的成員正在輸出。同樣地，JSDoc 會自動辨識 Node.js 模組中的特殊「module.exports」屬性。

CommonJS 模組
/**
 * A module that says hello!
 * @module hello/world
 */

/** Say hello. */
exports.sayHello = function() {
    return 'Hello world';
};
Node.js 模組
/**
 * A module that shouts hello!
 * @module hello/world
 */

/** SAY HELLO. */
module.exports = function() {
    return "HELLO WORLD";
};
輸出物件文字的 AMD 模組
define(function() {

    /**
     * A module that whispers hello!
     * @module hello/world
     */
    var exports = {};

    /** say hello. */
    exports.sayHello = function() {
        return 'hello world';
    };

    return exports;
});
輸出建構函式的 AMD 模組
define(function() {
    /**
     * A module that creates greeters.
     * @module greeter
     */

    /**
     * @constructor
     * @param {string} subject - The subject to greet.
     */
    var exports = function(subject) {
        this.subject = subject || 'world';
    };

    /** Say hello to the subject. */
    exports.prototype.sayHello = function() {
        return 'Hello ' + this.subject;
    };

    return exports;
});

如果模組輸出的物件名稱不是「exports」或「module.exports」，請使用 @exports 標籤來指出正在輸出的內容。

輸出物件的 AMD 模組
define(function () {

    /**
     * A module that says hello!
     * @exports hello/world
     */
    var ns = {};

    /** Say hello. */
    ns.sayHello = function() {
        return 'Hello world';
    };

    return ns;
});