javascript - 将 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因为它有更好的支持。根据他们的文档，您可以记录类模式。看看他们的例子，你应该很高兴！

干杯!