用JSDoc 3记录AMD模块中的类

Question

我正在尝试使用JavaScript 3在AMD JSDoc模块中记录一个类。

/**
 * A module representing a jacket.
 * @module my/jacket
 */
define('my/jacket', function() {
  /**
   * @class
   * @alias module:my/jacket
   */
  function Jacket() {
  }

  /**
   * Open and close your Jacket.
   */
  Jacket.prototype.zip = function() {
  };

  return Jacket;
});

它产生的输出如下所示：

类:模块:my/Class 模块:我/夹克 new module:my/jacket()

但我想读一读：

类:夹克 夹克 new Jacket()

有办法这样做吗？我使用的是jsdoc 3.4.1。

我尝试过将@class更改为@class Jacket，这几乎是可行的:类以正确的名称出现，但是zip方法的文档不会生成。

Answer 1

解决方案是使用@alias标记而不是模块名来设置类(函数)名称：

/**
 * A module representing a jacket.
 * @module my/jacket
 */
define('my/jacket', function() {
  /**
   * @class
   * @alias Jacket
   */
  function Jacket() {
  }

  /**
   * Open and close your Jacket.
   */
  Jacket.prototype.zip = function() {
  };

  return Jacket;
});

这将产生所需的输出：

类:夹克 夹克 new module:Jacket()

与zip方法文档一起使用。