Использование JSDoc с пространствами имен и вариантной формой определения функции

Question

Я пытался использовать JsDoc для документирования своего javascript, но я продолжаю сталкиваться с этим препятствием. Он продолжает говорить "ничего не задокументировано, выход"

Вот кусочек кода, который я пытаюсь документировать:

/**
 * Container for all editing methods
 * @namespace
 */
var FREdit = {

    /**
     * Toggle value for editing
     * @type Number
     */
    isToggleOn:0,

    /**
     * Initialize editing 
     */
    init: function(){
        this.initPopups();
    },

    /**
     * Function to enable editing 
     */
    enable: function(){
        this.enableTitles();
            this.isToggleOn = 1;
    }
};

Выше я использую пространство имен. Даже если я использую вариантную форму определения функции в JavaScript, JSDoc, похоже, не распознает ее. Например:

/**
 * Just any function
 */
var any_function = function(){

};

Есть идеи, как обойти это? Спасибо!

Answer 1

Судя по вашему вопросу, я предполагаю, что вы используете JSDoc. Оригинальный JSDoc уже некоторое время не поддерживается.

Я предлагаю вам использовать jsdoc-toolkit , поскольку он имеет гораздо лучшую поддержку. В соответствии с их документацией вы можете документировать шаблон класса . Взгляните на их примеры, и вам будет хорошо идти!

ура!