Использование 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-инструментарий поскольку у него гораздо лучшая поддержка.Согласно их документации, вы можете задокументируйте шаблон класса.Взгляните на их примеры, и у вас все должно получиться!

Ваше здоровье!