如何在ReactJS中做文档？

Question

我需要创建每个组件的doc文件 我们在reactjs应用程序中定义。我正在寻找我们的npm 可用于创建任何扩展的文档，以便它可以 提取代码，评论我的组件中的所有内容并进行更改 任何扩展的文件。我怎么能这样帮助我？我的问题与关于jsdoc的其他问题不同，因为我正在使用jsdoc在reactjs中查找文档。

Answer 1

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

打开命令提示符

 

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

 

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

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

Answer 2

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

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

• 从您定义的PropTypes生成API / props文档。
• 创建实时可编辑示例文档，让人们轻松复制粘贴代码段。
• 它具有良好的可配置性，并且具有热重新加载功能以实现内部文档。

它的工作原理是通过Webpack构建一个Web应用程序，您可以在本地使用或在某个地方为所有开发人员托管。

对我们而言，它运作良好，随着时间的推移，它们会有所改善。

编辑：是否使用react-docgen。

Answer 3

试试这个包，它有一些例子供你理解。

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

https://www.npmjs.com/package/@rtsao/react-docgen

Answer 4

我们有很多反应组件库并使用react-showroom

它允许在markdown中编写文档并具有沙箱。 这样做的一大优势 - 您可以在两分钟内使用已配置的webpack，babel，lint等启动新项目。

非常推荐尝试。

Answer 5

我已经为react-docgen编写了一个小包装器，这使得它更简单。它为传递的文件夹中的所有组件导出markdown文件。

结帐项目https://github.com/LaustAxelsen/wilster-doc

Answer 6

JSDoc有一个名为better-docs的主题，它有一个@component插件。当您将其添加到组件中（与其他标签一样）时，它将解析所有propTypes并生成文档。此外，当您将其与@example标记配合使用时，better-docs将打印实时预览。