डीओएम

Question

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

ये कुछ चीजें हैं प्रलेखन दिखाना चाहिए हैं:

1. विभिन्न घटकों की प्रासंगिक डोम तत्वों की वास्तविक नेस्टिंग।
2. घटनाओं के नाम और कहां से निकाल दिए जाते हैं।
3. किसी भी पेलोड जो कस्टम इवेंट से जुड़े होते हैं (उदाहरण के लिए प्रोटोटाइप कस्टम इवेंट में memo की सामग्री।)
4. ऐसी जगहें जहां ईवेंट मनाए जाते हैं।
5. अन्य घटनाओं के जवाब में किन घटनाओं को निकाल दिया जाता है इसके संकेत।
6. जहां घटनाओं को बुलबुला की अनुमति है, और जहां वे रुक गए हैं।

Answer 1

मैंने कभी भी वेब एप्लिकेशन फ्रंट-एंड के लिए एक स्थापित दस्तावेज़ मानक के बारे में नहीं सुना है।

यही कारण है, ने कहा कि जब से तुम कि आप ट्रैक करना चाहते अपने आवेदन के विभिन्न पहलुओं की पहचान की है, तो आप प्रत्येक ईवेंट हैंडलर के लिए एक docblock में यह जानकारी रखने के लिए, और jsdoc toolkit का उपयोग कुछ इनलाइन डॉक्स उत्पन्न करने के लिए कर सकता है।

IMHO, मुझे लगता है कि जब से तुम्हें पता है कि यह क्या है कि आप पहले से ही दस्तावेज़ के लिए चाहते हैं, आप जो कुछ भी प्रलेखन में प्रारूप आप के लिए सबसे समझ में आता है बनाने के लिए स्वतंत्र महसूस करना चाहिए, भले ही इसकी पूरी तरह से अपने एप्लिकेशन/संगठन के लिए अद्वितीय। बिना किसी जवाब के 8 घंटे स्टैक ओवरफ्लो का मतलब होना चाहिए कि कोई मानक उत्तर नहीं है;)

Answer 2

ईमानदारी से मैं दृश्य मॉडलर से प्यार करता था, और जब एमएस ने इसे Visio के लिए छोड़ दिया तो मैं कुछ हद तक निराश था।

यह कहा गया कि, Visio अभी भी एक अच्छा टूल है, और आप इसे घटकों के ऑब्जेक्ट मॉडल बनाने और घटनाओं, गुणों, विधियों आदि को परिभाषित करने के लिए उपयोग कर सकते हैं। इसमें कुछ यूएमएल डिज़ाइन और सभी के लिए कार्यक्षमता में बनाया गया है।

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

दुखी लगता है, लेकिन यह सच है!