javascript - 如何在ReactJS中做文档？

Question

我需要创建每个组件的文档文件我们在reactjs应用程序中定义。我正在寻找我们的 npm可以用来创建任意扩展名的文档，这样就可以提取代码，注释我的组件中的所有内容并更改它任何扩展的文档。我该怎么做，请帮助我？我的问题与关于 jsdoc 的其他问题不同，因为我正在使用 jsdoc 寻找 ReactJS 中的文档。

Answer 1

最后我找到了一个解决这个问题的工具:JSDoc.app

JSDoc 3 is an API documentation generator for JavaScript, similar to Javadoc or phpDocumentor. You add documentation comments directly to your source code, right alongside the code itself. The JSDoc tool will scan your source code and generate an HTML documentation website for you.

阅读他们的设置说明后，我能够执行以下步骤:-

• 打开命令提示符
• 通过命令全局安装 JSDoc:npm install jsdoc -g
• 现在转到项目文件夹的路径并运行命令:jsdoc src -r -d docs

这会在项目目录的 out/ 文件夹中创建 HTML 文档。