Mit JSDoc mit Namensräumen und eine Variante Form von Funktionsdefinition

Question

Ich habe versucht, JsDoc zu verwenden, um meinen Javascript dokumentieren, aber ich über diese Hürde komme immer. Es hält sagen „nichts zu dokumentieren, Beenden“

Hier ist die peice Code Ich versuche zu Dokument:

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

Vor I Namespace bin mit. Selbst wenn ich eine Variante Form von Funktionsdefinition in JavaScript verwenden, wird JSDoc nicht scheinen, um es zu erkennen. Zum Beispiel:

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

};

Jede Idee, wie dies zu umgehen? Dank!

Answer 1

Geht man von Ihrer Frage Ich vermute, Sie JSDoc verwenden. Die ursprüngliche JSDoc hat für eine Weile nicht unterstützt worden.

Ich schlage vor, Sie verwenden jsdoc-Toolkit , da es viel besser zu unterstützen hat. Nach ihrer Dokumentation können Sie ein href <= "http://code.google.com/p/jsdoc-toolkit/wiki/CookBook" rel = "nofollow noreferrer" title = "jsdoc-Tookit: Wie dokumentieren I (einige Muster)? "> dokumentieren die Klassenmuster . Werfen Sie einen Blick auf ihre Beispiele und Sie sollten gut gehen!

Cheers!