ReactJS में दस्तावेज़ कैसे करें?

Question

मुझे प्रत्येक घटक की दस्तावेज़ फ़ाइल बनाने की आवश्यकता है जिसे हम अपने रिस्पॉज एप्लिकेशन में परिभाषित करते हैं। मैं एनपीएम की तलाश में हूं कि हम किसी भी एक्सटेंशन के दस्तावेज़ को बनाने के लिए उपयोग कर सकते हैं, ताकि यह निकाला जा सके कोड, मेरे घटक से सब कुछ टिप्पणी करें और किसी भी एक्सटेंशन के दस्तावेज़ में बदलें। मैं यह कैसे कर सकता हूं कृपया मेरी सहायता करें? मेरा सवाल jsdoc के बारे में मिले अन्य प्रश्न से अलग है, क्योंकि मैं jsdoc का उपयोग कर प्रतिक्रियाओं में प्रलेखन की तलाश में हूं।

Answer 1

अंत में मैं समाधान, सबसे पहले इस लिंक पर जाएं और दस्तावेज़ ठीक से पढ़ पाया: - Read Document अब निम्न चरणों का पालन करें: -

आदेश से विश्व स्तर पर ओपन अपने कमांड प्रॉम्प्ट

JSDoc स्थापित करें: NPM स्थापित jsdoc जी

अब आप अपने प्रोजेक्ट फ़ोल्डर के पथ पर जाएँ और कमांड चलाएँ: jsdoc src -r -d डॉक्स

आदेश से ऊपर अपनी परियोजना निर्देशिका के दस्तावेज़ फ़ोल्डर में दस्तावेज़ का निर्माण करेगा।

Answer 2

इस पैकेज को आजमाएं आपके पास समझने के लिए उदाहरण हैं।

यह React.createClass, ES2015 कक्षा परिभाषाओं या कार्यों (स्टेटलेस घटक) के माध्यम से परिभाषित प्रतिक्रिया घटकों के लिए एक डिफ़ॉल्ट कार्यान्वयन प्रदान करता है। विश्लेषण करने योग्य होने के लिए इन घटक परिभाषाओं को कुछ दिशानिर्देशों का पालन करना होगा (अधिक जानकारी के लिए नीचे देखें)।

https://www.npmjs.com/package/@rtsao/react-docgen

Answer 3

हम React Styleguidist का उपयोग करके अपने प्रतिक्रिया घटकों पुस्तकालय दस्तावेज़।

यह निम्न सुविधाओं के साथ अपने कोड को पार्स होगा:

• उत्पन्न PropTypes आपके द्वारा निर्धारित से एपीआई/रंगमंच की सामग्री डॉक्स।
• लाइव संपादन योग्य उदाहरण दस्तावेज बनाएं जो लोगों को आसानी से स्निपेट पेस्ट करने की सुविधा देता है।
• यह बहुत अच्छी तरह से कॉन्फ़िगर करने योग्य है और आंतरिक दस्तावेज़ प्राप्त करने के लिए गर्म पुनः लोड किया गया है।

यह वेबपैक के माध्यम से एक वेब ऐप बनाकर काम करता है, ताकि आप स्थानीय रूप से उपयोग कर सकें या अपने सभी डेवलपर्स के लिए कहीं होस्ट कर सकें।

हमारे लिए, यह बहुत अच्छी तरह से काम करता है और वे समय के साथ इसे बेहतर बनाते हैं।

संपादित करें: हुड के नीचे react-docgen का उपयोग करता है।

Answer 4

हम एक बहुत घटक libs प्रतिक्रिया और react-showroom

का उपयोग यह markdown में प्रलेखन लिखने और सैंडबॉक्स की अनुमति देता है के लिए है। इसका एक बड़ा फायदा - आप पहले से कॉन्फ़िगर किए गए वेबपैक, बेबेल, लिंट इत्यादि के साथ दो मिनट में नई परियोजना शुरू कर सकते हैं

बहुत कोशिश करने की अनुशंसा करते हैं।

Answer 5

मैंने प्रतिक्रिया-डॉक्जेन के लिए एक छोटा सा रैपर लिखा है जो इसे काम करने के लिए थोड़ा आसान बनाता है। यह पास फ़ोल्डर में सभी घटकों के लिए एक मार्कडाउन फ़ाइल निर्यात करता है।

चेकआउट परियोजना https://github.com/LaustAxelsen/wilster-doc