eclipse,javascript和@memberof

时间:2014-02-27 17:34:48

标签: javascript eclipse requirejs jsdoc

我目前正在发现eclipse中的javascript支持。令我感到惊讶/困惑的一件事是大纲管理。

我在线阅读(理解“stackoverflow”当然;))我应该在方法上加上@memberof注释。

所以我在这里开始:

/**
 * @class CustomCanvas
 */
define([], function () {
    var draw;

    /**
     * @method draw
     * @memberOf CustomCanvas
     */
    draw = function () { ... };
});

而且......它不起作用。我的大纲保持空白。

但是如果我将@memberof注释移动到类文档中,它可以正常工作:

/**
 * @class CustomCanvas
 * @memberOf CustomCanvas
 */
define([], function () {
    var draw;

    /**
     * @method draw
     */
    draw = function () { ... };
});

那么正确的方法是什么?

1 个答案:

答案 0 :(得分:0)

如果您不想在文档中使用模块(无论出于何种原因),您可以这样做:

define(/** @lends global */function () {

/**
 * @class
 */
function CustomCanvas() {
}

/**
 * Draws something...
 */
CustomCanvas.prototype.draw  = function () {
};

return CustomCanvas;

});

如果您希望它位于文档中的模块中:

/**
 * @module foo
 */
define(/** @lends module:foo */ function () {

/**
 * @class
 */
function CustomCanvas() {
}

/**
 * Draws something...
 */
CustomCanvas.prototype.draw  = function () {
};

return CustomCanvas;

});

我通过jsdoc 3.2.2运行两个片段以确保它们正常工作。