如何在 ReactJS 中做文档？
How to do documentation in ReactJS?
我需要创建每个组件的文档文件
我们在我们的 reactjs 应用程序中定义。我正在寻找我们的 npm
可用于创建任何扩展名的文档，以便它可以
提取代码，注释我组件中的所有内容并进行更改
任何扩展名的文件。我该怎么做，请帮助我？我的问题与发现的关于 jsdoc 的其他问题不同，因为我正在使用 jsdoc 在 reactjs 中查找文档。
试试这个包，它有示例供您理解。
它为通过 React.createClass、ES2015 class 定义或函数（无状态组件）定义的 React 组件提供默认实现。这些组件定义必须遵循某些准则才能进行分析（有关详细信息，请参见下文）。
我们使用 React Styleguidist.
记录我们的 React 组件库
它将使用以下功能解析您的代码：
- 根据您定义的 PropTypes 生成 API / props 文档。
- 创建实时可编辑示例文档，让人们可以轻松复制粘贴代码段。
- 它的可配置性非常好，并且可以热重载以实现内部文档。
它的工作原理是通过 Webpack 构建一个 Web 应用程序，您可以在本地使用或在某个地方为所有开发人员托管。
对我们来说，它工作得很好，他们会随着时间的推移改进它。
编辑：在后台使用 react-docgen。
最后我找到了解决方案，首先转到这个 link 并正确阅读文档：-
Read Document
现在执行以下步骤：-
打开命令提示符
通过命令全局安装 JSDoc：npm install jsdoc -g
现在转到项目文件夹的路径并运行命令：jsdoc src -r -d docs
以上命令将在您的项目目录的 doc 文件夹中创建文档。
我们有很多 React 组件库并使用 react-showroom
它允许在 markdown 中编写文档并具有沙箱。
这样做的一大优势——你可以在两分钟内使用已经配置好的 webpack、babel、lint 等启动新项目
非常推荐尝试。
我已经为 react-docgen 编写了一个小包装器，这使得它的工作更简单一些。它为传递的文件夹中的所有组件导出降价文件。
JSDoc 有一个名为 better-docs 的主题，它有一个 @component 插件。当您将它添加到您的组件（与任何其他标签一样）时，它将解析您所有的 propTypes 并生成文档。此外，当您将它与@example 标签一起使用时 - better-docs 将打印实时预览。
我需要创建每个组件的文档文件 我们在我们的 reactjs 应用程序中定义。我正在寻找我们的 npm 可用于创建任何扩展名的文档，以便它可以 提取代码，注释我组件中的所有内容并进行更改 任何扩展名的文件。我该怎么做，请帮助我？我的问题与发现的关于 jsdoc 的其他问题不同，因为我正在使用 jsdoc 在 reactjs 中查找文档。
试试这个包，它有示例供您理解。
它为通过 React.createClass、ES2015 class 定义或函数（无状态组件）定义的 React 组件提供默认实现。这些组件定义必须遵循某些准则才能进行分析（有关详细信息，请参见下文）。
我们使用 React Styleguidist.
记录我们的 React 组件库它将使用以下功能解析您的代码：
- 根据您定义的 PropTypes 生成 API / props 文档。
- 创建实时可编辑示例文档，让人们可以轻松复制粘贴代码段。
- 它的可配置性非常好，并且可以热重载以实现内部文档。
它的工作原理是通过 Webpack 构建一个 Web 应用程序，您可以在本地使用或在某个地方为所有开发人员托管。
对我们来说，它工作得很好，他们会随着时间的推移改进它。
编辑：在后台使用 react-docgen。
最后我找到了解决方案，首先转到这个 link 并正确阅读文档：- Read Document 现在执行以下步骤：-
我们有很多 React 组件库并使用 react-showroom
它允许在 markdown 中编写文档并具有沙箱。 这样做的一大优势——你可以在两分钟内使用已经配置好的 webpack、babel、lint 等启动新项目
非常推荐尝试。
我已经为 react-docgen 编写了一个小包装器，这使得它的工作更简单一些。它为传递的文件夹中的所有组件导出降价文件。
JSDoc 有一个名为 better-docs 的主题，它有一个 @component 插件。当您将它添加到您的组件（与任何其他标签一样）时，它将解析您所有的 propTypes 并生成文档。此外，当您将它与@example 标签一起使用时 - better-docs 将打印实时预览。