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页面之后，我只看到枚举类型的doc而不是单个属性。

我已经尝试了以下/ **一些评论* / / ** @member {string} * /和/ ** @property {string} * /但似乎没有任何工作

Answer 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'
};

如何在JS Doc中记录枚举值

1 个答案: