Utilizzo di JSDoc con spazi dei nomi e una forma variante della definizione della funzione

Question

Ho provato a usare JsDoc per documentare il mio javascript ma continuo a imbattermi in questo ostacolo. Continua a dire " nulla da documentare, uscendo "

Ecco la parte di codice che sto cercando di documentare:

/**
 * 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;
    }
};

Sopra sto usando lo spazio dei nomi. Anche se utilizzo una variante della definizione della funzione in JavaScript, JSDoc non sembra riconoscerla. Ad esempio:

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

};

Qualche idea su come aggirare questo? Grazie!

Answer 1

A giudicare dalla tua domanda, immagino tu stia usando JSDoc. L'originale JSDoc non è più supportato da un po 'di tempo.

Ti suggerisco di utilizzare jsdoc-toolkit in quanto ha un supporto molto migliore. Secondo la loro documentazione puoi documenta il modello di classe . Dai un'occhiata ai loro esempi e dovresti essere bravo ad andare!

Cheers!