【问题标题】:eclipse, javascript and @memberof日食,javascript和@memberof
【发布时间】:2014-03-31 07:49:16
【问题描述】:

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

那么正确的做法是什么?

【问题讨论】:

  • define 调用是否意味着在 AMD 环境(如 RequireJS)中定义模块?
  • 是的,确实需要js。

标签: javascript eclipse requirejs jsdoc


【解决方案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 运行了两个 sn-ps 以确保它们正常工作。

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 2011-06-16
    • 2010-12-04
    • 2014-02-27
    • 2011-12-03
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多