javascript - eclipse、javascript 和 @memberof

Question

我目前正在发现 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 () { ... };
});

那么正确的做法是什么？

Answer 1

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

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 运行了这两个代码片段，以确保它们能够正常工作。