名前空間と関数定義のバリアント形式でJSDocを使用する

StackOverflow https://stackoverflow.com/questions/1228241

  •  22-07-2019
  •  | 
  •  

質問

JavaScriptの文書化にJsDocを使用しようとしてきましたが、このハードルに遭遇し続けています。 「文書化するものがありません、終了します」と言い続けます

ここに文書化しようとしているコードの一部を示します。

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

上記ではネームスペースを使用しています。 JavaScriptで関数定義のバリアント形式を使用しても、JSDocはそれを認識しないようです。例：

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

};

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

役に立ちましたか？

解決

質問から判断すると、JSDocを使用していると思います。 元のJSDocはしばらくサポートされていません。

jsdoc-toolkit サポートがはるかに優れているため。 彼らのドキュメントによると、クラスパターンを文書化します。 彼らの例を見てください、あなたは行くのが良いはずです！

乾杯！

ライセンス： CC-BY-SA と 帰属
所属していません StackOverflow
scroll top