नोड.जेएस परियोजनाओं के लिए ऑनलाइन प्रलेखन जनरेटर

दस्तावेज़ीकरण किसी भी परियोजना के सबसे महत्वपूर्ण घटकों में से एक है, खासकर अगर यह एक खुला स्रोत परियोजना है जो अन्य लोग पढ़ेंगे। ओपनसोर्स की दुनिया को थोड़ा बेहतर बनाने के लिए, मैंने नोडज परियोजनाओं के मॉड्यूल के आयोजन के क्षेत्र में अपने ज्ञान को इकट्ठा करने और मकडोक जैसे उपकरण बनाने की कोशिश की! । रूबी एडेप्ट के लिए ध्यान दें: यह लगभग रूडी के लिए rdoc.info के समान है।

यह उपकरण प्रोजेक्ट कोड का विश्लेषण करता है, कोड के संभावित रूप से प्रलेखित टुकड़ों (बिना किसी दस्तावेज़ के या बिना) पर प्रकाश डालता है, और परियोजना का वर्णन करने वाले पृष्ठों का एक स्थिर सेट उत्पन्न करता है।

संक्षेप में, उपयोग का पैटर्न इस प्रकार है: jsdoc.info/ पर जाएं। http://githubusername and/ [proproname] और तैयार परियोजना प्रलेखन देखें। या jsdoc.info/ Isgithubusername] पर जाएं और उन परियोजनाओं की सूची प्राप्त करें, जिनके लिए आप दस्तावेज़ तैयार कर सकते हैं।

कार्यान्वयन के विवरण के लिए, मैं बिल्ली के लिए पूछता हूं।


शुरुआत के लिए, यहाँ यह कैसा दिखता है:

jsdoc.info/visionmedia/express
jsdoc.info/jaredhanson/passport
jsdoc.info/1602/express-on-railway
jsdoc.info/1602/jugglingdb

यह कैसे काम करता है

Makedoc

कोड विश्लेषण के लिए makedoc मॉड्यूल जिम्मेदार है। यदि आपके प्रोजेक्ट को सार्वजनिक डोमेन में github पर होस्ट नहीं किया गया है, तो इस मॉड्यूल को एक अलग उपकरण के रूप में उपयोग किया जा सकता है। Makedoc तीन बुनियादी शब्दार्थ इकाइयों के लिए फाइल को पार करता है: कक्षा विधियाँ, उदाहरण विधियाँ, और बस विधियाँ। प्रत्येक फ़ाइल को या तो क्लास-फाइल के रूप में परिभाषित किया जाता है (जिसमें क्लास का विवरण होता है) या मॉड्यूल-फाइल के रूप में (कार्यों का निर्यात होता है)।

JSDoc

प्रलेखन के लिए अनुशंसित प्रारूप jsdoc है। हालांकि, वह इसे सख्ती से नहीं समझते हैं। परियोजना विकसित होते ही पूरा समर्थन मिलेगा। इसलिए, यदि आप विधि के लिए प्रलेखन पा सकते हैं, तो इसे मार्कडाउन का उपयोग करके पार्स किया जाता है, और विधि को "दस्तावेज" के रूप में चिह्नित किया जाता है। नतीजतन, हमारे पास "डॉक्स कवरेज" के रूप में ऐसी मीट्रिक है - प्रलेखन द्वारा कवर की गई लाइनों की संख्या का अनुपात जो अनजाने हुए लाइनों की संख्या है। अंतिम अंक के रूप में, परियोजना की कुल पंक्तियों की संख्या नहीं ली गई है, लेकिन विधियों में केवल लाइनें हैं, ताकि 100% का आंकड़ा प्राप्त हो सके।

टेक स्टैक: नोडज, रेलवेज, बूटस्ट्रैप, जेडडोम, जेकरी

प्रोजेक्ट 100mb RAM में एक होस्टिंग पर काम करता है, एक संकीर्ण चैनल और एक छोटी सी डिस्क के साथ, ताकि सब कुछ जल्दी से काम करे, प्रोजेक्ट हार्ड ड्राइव पर क्लोन नहीं किया जाता है, केवल आवश्यक फाइलें डाउनलोड की जाती हैं, html को jsdom + jessery का उपयोग करके पार्स किया जाता है। प्रारंभ में, रिपॉजिटरी क्लोनिंग के साथ एक संस्करण था जिसने बहुत धीमी गति से काम किया और किसी भी बेहतर नहीं। इसलिए, हम खुद को ./लिब डायरेक्टरी के स्रोत कोड तक सीमित रखते हैं और नेस्टिंग के दूसरे स्तर से अधिक नहीं है (90% चेक किए गए प्रोजेक्ट्स शामिल हैं)।

RailwayJS "मिस्ड" स्टेटिक मिडलवेयर अनुरोधों को पूरा करता है और उत्पन्न प्रलेखन भेजता है। आगे अनुरोध स्टेटिक्स द्वारा दिए गए हैं।

योजनाओं

परियोजना एक सप्ताह पुरानी है, इसलिए अब के लिए एक पूर्ण न्यूनतम का एहसास हुआ है जिसे दिखाया जा सकता है। अधिक से अधिक परियोजनाओं का समर्थन करने के लिए पार्सर को विकसित करने और सुधारने की योजना है। अगली प्राथमिकता: पीढ़ी प्रक्रिया का स्वचालन। पहले से, आप / उपयोगकर्ता / रेपो / अपडेट के लिए एक POST अनुरोध भेज सकते हैं और मिथुन पर POST- प्राप्त हुक का उपयोग करके दस्तावेज़ को अपडेट कर सकते हैं। लेकिन इसे कौन कॉन्फ़िगर करेगा? यह ट्रैविस-सीआई की तरह होना चाहिए: एक टॉगल स्विच और आप कर रहे हैं।

जब तक पीढ़ी के अनुरोध को समय में अलग किया जाता है, तब तक सब कुछ त्रुटिपूर्ण रूप से काम करता है, क्योंकि स्थैतिक जल्दी से दिया जाता है, और विश्लेषण के लिए बड़े संसाधनों की आवश्यकता नहीं होती है। हालांकि, अगर परियोजना "उड़ती" है और मांग में है, तो अधिक गंभीर हार्डवेयर की आवश्यकता होगी। इसलिए, मैं आपको एक संभावित हब्र प्रभाव के लिए वफादारी से विशेषता देने के लिए कहता हूं।

फिलहाल, हमें संसाधन का उपयोग करने में रुचि रखने वाले परियोजना मालिकों से वास्तव में प्रतिक्रिया की आवश्यकता है। इस समुदाय के सक्रिय प्रतिभागियों के साथ एक समुदाय-उन्मुख परियोजना के विकास की दिशा चुनना सबसे अच्छा है, जिसे मैं एक हब पर खोजना चाहता हूं

धन्यवाद!

पुनश्च: साइट पर पाई गई समस्याओं के लिए, यहां समस्याएं बनाएं: github.com/1602/railway-jsdoc-generator/issues
दस्तावेज़ जनरेटर के साथ समस्याओं के बारे में यहाँ लिखें: github.com/1602/makedoc/issues