如何在JS文檔中記錄枚舉值

Question

我正在使用JS文檔爲JS生成文檔。我有一個價值很少的枚舉。我想爲每個屬性生成文檔。我嘗試了以下內容：

/** 
* Enum for display state. 
* @readonly 
* @enum {string} 
*/ 
var DisplayState = { 
    /** @member {string} */ 
    foreground: 'foreground', 
    /** @member {string} */ 
    background: 'background', 
    /** @member {string} */ 
    projected: 'projected' 
}; 

但是，在生成HTML頁面後，我只能看到doc爲枚舉類型而不是單個屬性。

我試過以下/ **一些註釋*// ** @member {string}裏* /和/ ** @property {string}裏* /但似乎沒有任何工作

Answer 1

我升級到JS Doc的第3版（https://github.com/jsdoc3/jsdoc），此問題已修復。

見下文實例：

/** 
* Enum for display state. 
* @readonly 
* @enum {string} 
*/ 
var DisplayState = { 
    /** @member {string} */ 
    /** The app is running in the foreground and can receive user input. */ 
    foreground: 'foreground', 

    /** @member {string} */ 
    /** The app is in the background and can't receive user input. */ 
    background: 'background', 

    /** @member {string} */ 
    /** The app is running in Phone Projection mode (Android Auto or Apple Car Play). */ 
    projected: 'projected' 
};