如何在ReactJS中做文档？

Question

我需要创建我们在reactjs应用程序中定义的每个组件的doc文件.我正在寻找可用于创建任何扩展文档的npm,以便它可以提取代码,评论来自我的组件并将其更改为任何扩展名的文档.如何帮助我？我的问题与关于jsdoc的其他问题不同,因为我正在使用jsdoc在reactjs中查找文档.

Answer 1

最后我找到了解决方案,首先转到此链接并正确阅读文档: - 阅读文档现在执行以下步骤: -

打开命令提示符

通过命令全局安装JSDoc:npm install jsdoc -g

现在转到项目文件夹的路径并运行命令:jsdoc src -r -d docs

上面的命令将在项目目录的doc文件夹中创建文档.

避免在全球范围内安装内容是个好主意.相反,您可以使用`npm install jsdoc --save-dev`来仅在项目中安装它.然后添加一个npm脚本来创建doc.例如``createdoc':"jsdoc src -r -d docs"`然后你可以用`npm run createdoc`运行. (12认同)
你好，我感兴趣的是你如何使用 JSDoc 正确地对组件做出反应？ (2认同)

Answer 2

我们使用React Styleguidist记录我们的React组件库.

它将使用以下功能解析您的代码:

它的工作原理是通过Webpack构建一个Web应用程序,您可以在本地使用,也可以在所有开发人员的位置托管.

对我们来说,它运作良好,随着时间的推移它们会改进.

编辑:是否使用react-docgen.

Answer 3

试试这个包，它有例子让你理解。

它为通过 React.createClass、ES2015 类定义或函数（无状态组件）定义的 React 组件提供了默认实现。这些组件定义必须遵循某些准则才能进行分析（有关更多信息，请参见下文）。