如何制作react-styleguide来支持JSDoc参数的show文档？

Question

无论我在做什么，我都不能为使用JSDoc的组件生成文档。

例如

以下代码：

/**
 * @param {{name:string}} props
 * */
export function Button(props) {

}

应该会告诉我：

​

​

要查看道具，我必须使用propTypes

Button.propTypes = {
  name: PropTypes.string,
}

那么，如何让react-styleguidist与JSdoc (甚至是某种typescript)一起工作呢？

一个有效的例子将会受到欢迎。

Answer 1

您只能在记录道具时使用@param。

在这里您可以找到有关如何使用JSDoc标记的更多信息：https://react-styleguidist.js.org/docs/documenting.html#using-jsdoc-tags