如何在 JS Doc 中记录枚举值

Question

我正在使用 JS Doc 生成 JS 文档。我有一个值很少的枚举。我想为每个属性生成文档。我尝试了以下方法：

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

但是生成 HTML 页面后，我只看到枚举类型的文档，而不是单个属性。

我已经尝试过以下 /** 一些评论 */ /** @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'
};