在sphinx-js中记录一个简单的JavaScript对象。

Question

我有一个使用JSDoc标签记录的对象。

/**
 * Some description of this object.
 * @memberof Constants#
 * @readonly
 * @enum {string}
 * @property {string} CONST1 Explanation of const 1.
 * @property {string} CONST2 Explanation of const 2.
 */
 SomeObject: {
     CONST1: "const1",
     CONST2: "const2"
 },

当使用 sphinx-js 生成文档时，只有名称、描述和类型（这里是字符串）被记录下来，但没有提到 CONST1 或 CONST2 属性。

有没有办法让sphinx-js可以显示这个对象的属性值？有什么变通的办法吗？

Answer 1

它看起来不像 sphinx-js 目前支持这个功能。 在项目中 README:

到目前为止，我们理解并转换了JSDoc块标签@param、@returns、@throws、@example（不含可选的）、@deprecated、@see以及它们的同义词。其他的都会噗通一声消失不见。

不幸的是，我没有立即看到一个变通的办法来解决这个问题。