如何使用 ESDoc 记录包含对象的对象

Question

我正在尝试使用 ESDoc（类似于 JSDoc 的语法）在 class 构造函数中记录包含其他对象的对象。

/** 
 * A description.
 * @type {object}
 */
this.materialProperties = {
    paper: {
        roughness: 0.5,
        metalness: 0.0,
        reflectivity: 0.5
    },
    wood: {
        roughness: 0.5,
        metalness: 0.0,
        reflectivity: 0.5
    },
    metal: {
        roughness: 0.5,
        metalness: 0.5,
        reflectivity: 0.9,
        clearCoat: 1,
        clearCoatRoughness: 0
    },
    glass: {
        roughness: 0.5,
        metalness: 0.5,
        reflectivity: 0.9,
        clearCoat: 1,
        clearCoatRoughness: 0,
        opacity: 0.5,
        transparent: true
    }
}

但是，当我运行文档时，该行被标记为未记录，并且生成的文档中没有显示任何内容。

如何记录这一行？谢谢！

Answer 1

问题是 ESDoc 中存在一个错误，如果您有一个包含对象的对象，那么无论您做什么，都不会记录该行之后的内容。

我在这里的 ESDoc 中创建了一个问题：

https://github.com/esdoc/esdoc/issues/549

如何使用 ESDoc 记录包含对象的对象

How to document an object containing objects with ESDoc

javascript

jsdoc

esdoc