Utilisation de JSDoc avec des espaces de noms et une variante de la définition de fonction

Question

J'ai essayé d'utiliser JsDoc pour documenter mon javascript, mais je rencontre toujours cet obstacle. Il ne cesse de dire "rien à documenter, exiting"

Voici le code que je peice essaie de document:

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

Au-dessus, je suis en utilisant l'espace de noms. Même si j'utilise une variante de définition de fonction dans JavaScript, JSDoc ne semble pas le reconnaître. Ex:

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

}; 

Une idée pour contourner ce problème? Merci!

Answer 1

À en juger par votre question, je suppose que vous utilisez JSDoc. Le fichier JSDoc d'origine n'est plus pris en charge depuis un moment.

Je suggère que vous utilisez jsdoc-toolkit car il a un bien meilleur support. D'après leur documentation, vous pouvez document the class pattern. Jetez un oeil à leurs exemples et vous devriez être prêt à partir!

À la votre!