如何正确记录React / Redux应用程序？

Question

我目前正在记录用ES6编写的React / Redux应用程序，但我找不到任何有用的信息，这是记录React应用程序的最恰当方式。

在此post中，提供了工具react-docgen，我也偶然发现了esdoc。 esdoc 自动生成文档， react-docgen 提取React组件的信息并将其放入JSON文件中。

由于我的应用程序不仅是React，还有Redux，我找不到记录应用程序的最佳方法。一般来说，我不认为我应该混合使用它们，我认为 esdoc 更适合我，但我不完全相信我应该用 esdoc 作为生命周期钩子，proptypes，自己的方法等。

有没有人偶然发现这个问题，可以告诉我记录这样一个应用程序的正确方法是什么？

Answer 1

用于记录ES6应用程序的一些工具：

documentationjs

Documentationjs是一个新的文档生成器。它支持ES6，允许您以标准JSDoc格式编写文档注释。

ESDoc

ESDoc支持JSDoc语法，解析大部分ES6并输出不错，它集成了Mocha。

JSDoc

JSDoc部分支持ES6。