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

jua*_*lob 8 javascript reactjs redux

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

在这篇文章中,提出了工具react-docgen,我也偶然发现了esdoc.而esdoc确实自动生成的文档,反应-docgen提取反应的组分的信息,并将其放入一个JSON文件中.

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

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

Gib*_*boK 8

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

documentationjs

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

ESDoc

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

JSDoc

JSDoc部分支持ES6.

  • 虽然工具很好而且我确实使用它们,但我的问题不是关于工具,而是关于应用程序文档的内容.我不能接受它作为一个有效的答案,但我认为你的链接有用,所以我赞成它 (2认同)