名前空間とバリアント形式の関数定義で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; 
    } 
}; 

私は名前空間を使用しています上：それはここで

は、私が文書にしようとしているコードのpeiceである「出、文書化することは何も」と言っていないし続けます。 JavaScriptで関数定義のバリエーションフォームを使用しても、JSDocはそれを認識していないようです。例：

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

}; 

これを回避する方法はありますか。ありがとう！

Answer 1

ご質問から、私はあなたがJSDocを使用していると推測しています。 オリジナルのJSDocは今のところサポートされていません。

もっと良いサポートがあるので、jsdoc-toolkitを使用することをお勧めします。 彼らのドキュメントによれば、あなたはdocument the class patternです。 彼らの例を見て、あなたは行くのが良いはずです！

乾杯！