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

前端之家收集整理的这篇文章主要介绍了javascript – 如何正确记录React / Redux应用程序?前端之家小编觉得挺不错的,现在分享给大家,也给大家做个参考。
我目前正在记录用ES6编写的React / Redux应用程序,但我找不到任何有用的信息,这是记录React应用程序的最恰当方式.

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

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

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

解决方法

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

documentationjs

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

ESDoc

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

JSDoc

JSDoc部分支持ES6.

猜你在找的JavaScript相关文章