Verwenden von JSDoc mit Namespaces und eine Variante der Funktionsdefinition

Question

Ich habe versucht, JsDoc für die Dokumentation meiner Javascript verwenden, aber ich komme immer wieder über diese Hürde. Es sagt immer "nichts zu dokumentieren, verlässt"

Hier ist die peice der Code, den ich zu dokumentieren versucht:

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

Above I Namespace bin mit. Auch wenn ich eine variante Form der Funktionsdefinition in JavaScript verwende, scheint JSDoc es nicht zu erkennen. ZB:

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

}; 

Irgendeine Idee, wie man das umgehen kann? Vielen Dank!

Answer 1

Ausgehend von Ihrer Frage, ich vermute, Sie verwenden JSDoc. Die ursprüngliche JSDoc wurde für eine Weile nicht mehr unterstützt.

Ich schlage vor, Sie verwenden , da es viel bessere Unterstützung hat. Entsprechend ihrer Dokumentation können Sie document the class pattern. Werfen Sie einen Blick auf ihre Beispiele und Sie sollten gut gehen!

Prost!