admin管理员组

文章数量:1345017

I'm currently documenting a React/Redux application written in ES6 and I cannot find any useful information what's the most properly way to document a React application.

In this post, the tool react-docgen is presented, and I have stumble upon esdoc as well. Whereas esdoc does automatic generation of documentation, react-docgen extracts the information of the React ponents and puts it into a JSON file.

As my application is not only React, but also Redux, I cannot find the best way to document the application. Generally speaking, I don't think that I should mix both of them and I think esdoc suits me better, but I'm not fully convinced what should I be documenting with esdoc as of lifecycle hooks, proptypes, own methods, etc..

Has anyone stumbled upon this problem and can tell me what's a proper way of documenting such an application?

I'm currently documenting a React/Redux application written in ES6 and I cannot find any useful information what's the most properly way to document a React application.

In this post, the tool react-docgen is presented, and I have stumble upon esdoc as well. Whereas esdoc does automatic generation of documentation, react-docgen extracts the information of the React ponents and puts it into a JSON file.

As my application is not only React, but also Redux, I cannot find the best way to document the application. Generally speaking, I don't think that I should mix both of them and I think esdoc suits me better, but I'm not fully convinced what should I be documenting with esdoc as of lifecycle hooks, proptypes, own methods, etc..

Has anyone stumbled upon this problem and can tell me what's a proper way of documenting such an application?

  • javascript
  • reactjs
  • redux
Share Improve this question edited May 30, 2017 at 14:05 GibboK 74k148 gold badges451 silver badges674 bronze badges asked May 30, 2017 at 13:18 juanecabellobjuanecabellob 4543 silver badges14 bronze badges
Add a ment  | 

1 Answer 1

Reset to default 10

Some tools for documenting your ES6 application:

documentationjs

Documentationjs is a new documentation generator. It supports ES6 and allows you to write your doc ments in standard JSDoc format.

ESDoc

ESDoc supports JSDoc syntax, parses most of ES6 and outputs nice and it integrates Mocha.

JSDoc

JSDoc supports ES6 partially.

本文标签： javascriptHow to properly document a ReactRedux applicationStack Overflow

版权声明：本文标题：javascript - How to properly document a ReactRedux application? - Stack Overflow 内容由网友自发贡献，该文观点仅代表作者本人， 转载请联系作者并注明出处：http://www.betaflare.com/web/1743756240a2533561.html， 本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容，一经查实，本站将立刻删除。