JSDoc - Modulize - PullRequest
       17

JSDoc - Modulize

0 голосов
/ 06 марта 2019

Я тестирую JSDoc.Я нашел этот пример :

 /**
 * @classdesc Toaster singleton.
 * @class
 * @hideconstructor
 */
var Toaster = (function() {
    var instance = null;

    function Toaster() {}

    /**
     * Toast an item.
     *
     * @alias toast
     * @memberof Toaster
     * @instance
     * @param {BreadyThing} item - The item to toast.
     * @return {Toast} A toasted bready thing.
     */
    Toaster.prototype.toast = function(item) {};

    return {
        /**
         * Get the Toaster instance.
         *
         * @alias Toaster.getInstance
         * @returns {Toaster} The Toaster instance.
         */
        getInstance: function() {
            if (instance === null) {
                instance = new Toaster();
                delete instance.constructor;
            }

            return instance;
        }
    };
})();

Этот фрагмент работает очень хорошо и экспортирует правильный результат.Все указанные свойства, методы и класс Toast доступны в документации, но если я помещу этот класс в пространство имен / модуль, я не получу никакого вывода.Моя упаковка выглядит так:

 /**
 * @namespace Toast
 */
var ToastModule = (function (mn, $) {
    "use strict";

    // Make private state accessible across files
    var _private = mn._private = mn._private || {};

/**
 * @classdesc Toaster singleton.
 * @class
 * @hideconstructor
 */
var Toaster = (function() { ....
})();

return mn; 
}(ToastModule || {}, j$1_10_2)); // Module ToastModule// 

Я могу добавить «@memberof Toast».тег, но я должен сделать это для каждого класса, свойства и т. д. Так что это очень неудобно, и я думаю, что не правильный путь.Может ли кто-нибудь направить меня в правильном направлении?

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...