स्रोत कोड सीखने और दस्तावेज करने पर एक नया रूप

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

समस्या

हाल ही में, मैंने उन मुख्य समस्याओं के बारे में एक सर्वेक्षण किया, जिनका सामना हम तब करते हैं जब हम किसी बड़ी परियोजना के स्रोत कोड का अध्ययन करना शुरू करते हैं (यदि आपने अभी तक भाग नहीं लिया है, तो आप अभी भी यहाँ सर्वेक्षण पूरा कर सकते हैं )।

मुख्य सवाल जो मुझे दिलचस्पी था: क्या वास्तव में आपके लिए एक नई परियोजना के लिए कोड सीखने का सबसे कठिन हिस्सा है? आइए नीचे दी गई तस्वीर में प्रतिक्रियाओं की प्रवृत्ति को देखें।



जैसा कि अपेक्षित था, सभी बिंदुओं को एक ही तस्वीर में संयोजित करना अधिक कठिन है, यह समझने के लिए कि किसी विशेष फ़ंक्शन या फ़ाइल के अंदर कोड क्या करता है (अजीब तरह से, कोड संपादक "पूरी तस्वीर के बजाय" एक फ़ाइल "पर अधिक ध्यान देते हैं" ")। समस्या यह है कि जब हम पहली बार प्रोजेक्ट कोड खोलते हैं, तो एक बार में बहुत अधिक जानकारी हम पर डंप हो जाती है। हम पूरी तरह से अराजकता में फ़ाइलों के बीच कूदना शुरू करते हैं, अक्सर एक ही फ़ाइल को कई बार खोलते हैं, यह महसूस करते हुए कि "ओह, मैंने पहले ही यह देख लिया था, यह जगह नहीं है" या "सही जगह जहां मैंने देखा है ”और समय बर्बाद कर रहे हैं। इसलिए, हमें निश्चित रूप से कोड में महत्वपूर्ण स्थानों को चिह्नित करने के लिए किसी तरह के टूल की आवश्यकता है और, आदर्श रूप से, सब कुछ कैसे काम करता है, इसका "सामान्य दृश्य चित्र" बनाने के लिए।

बचाव के लिए कोड्रेक्रम्स

Codecrumbs (नाम "कोड" और "ब्रेडक्रंब" से लिया गया है) एक उपकरण है जो आपको कोड में "ब्रेड क्रंब" छोड़ने और उन पर एक दृश्य आरेख बनाने की अनुमति देता है।

यह कैसे काम करता है? आप कोडेक कोड्स को निष्पादित करते हैं जो प्रोजेक्ट कोड के रास्तों को निर्दिष्ट करते हैं, कोडेक्स स्रोत कोड का विश्लेषण करते हैं और इसके दृश्य प्रतिनिधित्व का निर्माण करते हैं। कोडक्रम्ब-टिप्पणी जोड़ें और कोड आधार की अद्यतन स्थिति मक्खी पर ब्राउज़र में दृश्य क्लाइंट में प्रदर्शित की जाएगी।

मुख्य विशेषताएं

ब्रेडक्रंब का निशान ("टुकड़ों की श्रृंखला") - टुकड़ों का एक क्रम जो आवेदन के अंदर कुछ प्रकार के परिदृश्य का वर्णन करता है (उदाहरण के लिए, प्रमाणीकरण या सर्वर को एक फॉर्म सबमिट करना, आदि)।



निर्भरता का पेड़ ("निर्भरता का वृक्ष") - यह निर्धारित करना आसान बनाता है कि "क्या आयात किया जा रहा है"।



फ़्लोचार्ट ("फ़्लोचार्ट") - आपको चयनित फ़ाइल के फ़्लोचार्ट को देखने की अनुमति देता है।



इसके अलावा, बस एक ही समय में कई प्रोजेक्ट्स के लिए "कोडट्रैम्ब" चलाकर, आप एक-दूसरे के साथ उनके एकीकरण का अध्ययन कर सकते हैं।



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



भाषा का समर्थन वर्तमान संस्करण में निम्नलिखित प्रोग्रामिंग भाषाओं का समर्थन किया गया है:

• जावास्क्रिप्ट
• टाइपप्रति
• अजगर
• पीएचपी
• जावा
• सी ++

जावास्क्रिप्ट बाकी की तुलना में अधिक कार्यक्षमता प्रदान करता है, क्योंकि यह अकेले ही कोड को संसाधित करने के लिए एएसटी पार्सर का उपयोग करता है।

आगे की योजना

यह टूल (कोडरमाब्स) आपको कोड बेस को तेजी से अध्ययन, दस्तावेज और व्याख्या करने की अनुमति देता है। इसके अलावा, "डाउनलोड / अपलोड" फ़ंक्शन कोड शोध के परिणामों को वितरित करना बहुत आसान बनाता है। अंतिम लक्ष्य https://codecrumbs.io पर इस तरह के "मामलों" की एक बहुत जगह है और कोडेक प्रोजेक्ट लाइब्रेरी के साथ समझाया की शैली में कुछ प्राप्त करना है - एक ऐसी जगह जहां हर कोई वास्तविक परियोजनाओं के उदाहरणों पर ज्ञान साझा कर सकता है।

अधिक शांत सुविधाएँ जल्द ही आ रही हैं, देखते रहें! और हाँ, "स्टार" पर क्लिक करें और अपने दोस्तों को बताएं :) जीथब रिपॉजिटरी यहाँ है github.com/Bogdan-Lyashenko/codecrumbs । धन्यवाद!