Comment faire de la documentation dans ReactJS?
J'ai besoin de créer le fichier doc de chacun des composants que nous définissons dans notre application reactjs.Je cherche le npm que nous pouvons utiliser pour créer le document de n'importe quelle extension, afin qu'il puisse extraire le code, commenter tout de mon composant et le changer dans le document de toute extension. Comment puis-je faire s'il vous plaît m'aider? Ma question est différente de l'autre question trouvée concernant le jsdoc, car je cherche la documentation dans reactjs en utilisant jsdoc.
Enfin, j'ai trouvé la solution, allez d'abord sur ce lien et lisez correctement le document: - Lire le document Maintenant, procédez comme suit: -
Nous documentons notre bibliothèque de composants React en utilisant React Styleguidist .
Il analysera votre code avec les fonctionnalités suivantes:
- générer des documents API/accessoires à partir des PropTypes que vous définissez.
- Créez une documentation d'exemples modifiables en direct qui permet aux utilisateurs de copier-coller facilement des extraits.
- Il est assez bien configurable et dispose d'un rechargement à chaud pour obtenir des documents internes.
Il fonctionne en créant une application Web via Webpack, que vous pouvez utiliser localement ou héberger quelque part pour tous vos développeurs.
Pour nous, cela fonctionne plutôt bien et ils l'améliorent avec le temps.
Edit: Est utilise react-docgen sous le capot.
Essayez ce package, il contient des exemples que vous pouvez comprendre.
Il fournit une implémentation par défaut pour les composants React définis via React.createClass, les définitions de classe ES2015 ou les fonctions (composants sans état). Ces définitions de composants doivent suivre certaines directives pour être analysables (voir ci-dessous pour plus d'informations). Info).
Il y a un thème pour JSDoc appelé better-docs et il a un plugin @component. Lorsque vous l'ajoutez à votre composant (comme toutes les autres balises), il analysera tous vos propTypes et générera de la documentation. De plus, lorsque vous l'utilisez avec une balise @example, better-docs imprimera un aperçu en direct.
Nous avons beaucoup de bibliothèques de composants React et utilisons react-showroom
Il permet d'écrire de la documentation en markdown et d'avoir un sandbox. Un gros avantage de cela - vous pouvez démarrer un nouveau projet en deux minutes avec un webpack déjà configuré, babel, lint, etc.
Je recommande vivement d'essayer.
J'ai écrit un petit wrapper pour react-docgen qui le rend un peu plus simple à travailler. Il exporte un fichier de démarque pour tous les composants du dossier transmis.
Commander le projet https://github.com/LaustAxelsen/wilster-doc