无论我在做什么,我都无法为使用JSDoc的组件生成文档。
例如
以下代码:
/**
* @param {{name:string}} props
* */
export function Button(props) {
}
应该告诉我:
要查看道具,我必须使用propTypes
Button.propTypes = {
name: PropTypes.string,
}
因此,如何使react-styleguidist
与JSdoc(甚至某种打字稿)一起使用。
一个有效的例子将不胜感激。
答案 0 :(得分:1)
在记录道具时只能使用@param。
在这里您可以找到有关如何使用JSDoc标签的更多信息: https://react-styleguidist.js.org/docs/documenting.html#using-jsdoc-tags