將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;
    }
};

上面我正在使用命名空間。 即使我在JavaScript中使用函數定義的變體形式，JSDoc似乎也無法識別它。 例如：

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

};

任何想法如何解決這個問題？ 謝謝！

Answer 1

從您的問題來看，我猜您正在使用JSDoc。 原始JSDoc已有一段時間不受支持。

我建議您使用jsdoc-toolkit，因為它具有更好的支持。 根據他們的文檔，您可以記錄類模式 。 看看他們的例子，您應該一切順利！

干杯!