javascript - 是否可以使用 ESDOC 记录一个 javascript 普通对象？

Question

ESDOC 似乎只针对 ES6 类样式。

有没有办法记录一个普通的对象，比如:

/**
 * ???
 */
var Foo = {
    /**
     * ???
     */
    info: true
};

export default Foo;

甚至在使用 ES6 类样式时，如何记录静态属性，例如:

class Bar {
}

/**
 * ???
 */
Bar.info = true;

export default Bar;

Answer 1

简答。没有。

ESDOC 专门用于记录 ES6 类。它的名字是正确的。来自FAQ :

ESDoc supports ES2015 and later

如果您需要记录 ES6+ 和常规(原型(prototype))类的混合，JSDOC可能是更好的选择。它相当成熟，其格式是一种事实上的标准。

如果您不喜欢或不能使用主要的 JSDOC 包，还有很多其他选择。举个例子，我在 jsdoc-to-markdown 上取得了成功在我的项目上。您应该能够找到将 JSDOC 转换为您需要的任何格式的工具。