我目前正在记录一个用 ES6 编写的 React/Redux 应用程序,但我找不到任何有用的信息,什么是记录 React 应用程序的最正确方法。
在此post , 工具 react-docgen出现了,我偶然发现了esdoc以及。 esdoc 自动生成文档,react-docgen 提取 React 组件的信息并将其放入 JSON
文件中。
由于我的应用程序不仅是 React,而且是 Redux,所以我找不到最好的方式来记录应用程序。一般来说,我不认为我应该混合使用它们,我认为 esdoc 更适合我,但我不完全相信我应该用 esdoc 从生命周期钩子(Hook)、proptypes、自己的方法等开始。
有没有人偶然发现这个问题并能告诉我记录此类应用程序的正确方法是什么?
最佳答案
一些用于记录 ES6 应用程序的工具:
documentationjs
Documentationjs 是一个新的文档生成器。它支持 ES6 并允许您以标准的 JSDoc 格式编写文档注释。
ESDoc
ESDoc支持JSDoc语法,解析大部分ES6输出nice,集成了Mocha .
JSDoc
JSDoc 部分支持 ES6。
关于javascript - 如何正确记录 React/Redux 应用程序?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/44263430/