使用JSDoc 3在AMD模块中记录类

Question

我正在尝试使用JSDoc 3在AMD JavaScript模块中记录一个类。这是我的代码，基于此处文档中的示例：

/**
 * 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;
});

产生的输出如下所示：

类别：模块：我/夹克

模块：我/夹克

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方法文档。