如何在 JS Doc 中记录枚举值答案

【问题标题】：how to document enum values in JS Doc如何在 JS Doc 中记录枚举值
【发布时间】：2016-10-11 23:00:03
【问题描述】：

我正在使用 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} */ 但似乎没有任何效果

【问题讨论】：

你试过删除@member吗？
usejsdoc.org/tags-enum.html
是的，我试过了 1. 删除成员 2. 添加属性 3. 删除成员和属性
什么版本的jsdoc？
JS 文档版本 2.4.0

标签： javascript jsdoc

【解决方案1】：

我已升级到 JS Doc (https://github.com/jsdoc3/jsdoc) 的第 3 版，此问题已得到修复。

请看下面的例子：

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

【讨论】：