文檔化一類的AMD模塊與JSDoc 3

Question

我試圖使用JSDoc 3.記錄了AMD的JavaScript模塊中的類下面是我的代碼的基礎上，例如文檔here在：

/** 
* 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方法文檔。