javascript - 如何制作 react-styleguide 以支持显示 JSDoc 参数的文档？

Question

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

例如

以下代码：

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

}

应该告诉我：

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

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

那么，如何react-styleguidist使用 JSdoc（甚至是某种打字稿）。

一个工作示例将不胜感激。

Answer 1

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

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