2010-08-06 14 views
6

मुझे बहुत सारे जावास्क्रिप्ट और jQuery कोड को दस्तावेज़ करने की आवश्यकता है। मुझे लिखित दस्तावेज के बजाय आरेखों में दिलचस्पी है।आप अपनी जावास्क्रिप्ट को कैसे दस्तावेज़ करते हैं?

मुझे आश्चर्य है कि मॉडलिंग के लिए कुछ प्रकार के मानक हैं जावास्क्रिप्ट फ़ंक्शंस? मेरा लक्ष्य यह दिखाना है कि अलग-अलग कार्य एक दूसरे के साथ कैसे बातचीत करते हैं।

धन्यवाद

संपादित करें: मैं DFDS और अनुक्रम आरेख कोशिश कर रहे हैं, लेकिन यह रूप में अच्छी तरह काम कर रहा है के रूप में मैं यह करना चाहते हैं। मेरे पास डीएफडी में प्रक्रियाओं के लिए फ़ंक्शन कॉल मैप करने का विकल्प है, लेकिन यह आरेख को बहुत भ्रमित कर देता है और एक फ़ंक्शन से दूसरे फ़ंक्शन में फायरबग कूदना आसान होता है।

फ़ंक्शन नामों के साथ अलग-अलग कॉलिंग प्रक्रिया का अर्थ है कि जब मैं आरेख को पढ़ता हूं तो इसे जावास्क्रिप्ट पर मैप करना आसान नहीं होगा ... कुछ scerenshots को थोड़ा सा पोस्ट करेगा।

उत्तर

5

कोई उपकरण इस के लिए उपलब्ध है, लेकिन मेरे हिसाब से तो आप इस जो OOD में प्रयोग किया जाता है के लिए एक यूएमएल अनुक्रम आरेख का उपयोग समारोह के बीच प्रवाह कॉल को दिखाने के लिए कर सकते हैं या आप प्रवाह चार्ट का उपयोग दिखाने के लिए कर सकते हैं नियंत्रण प्रवाह।

नोट: ऑब्जेक्ट नाम अपने जावास्क्रिप्ट के साथ फाइल

अनुक्रम आरेख

alt text http://click.sourceforge.net/images/get-sequence-diagram.png

+0

मैं इसे एक दूंगा, कुछ आसान के साथ शुरू करने की आवश्यकता है! प्रवाह चार्ट के लिए आप –

+0

पर जा सकते हैं क्योंकि प्रवाह बनाने के लिए यह आसान है और प्रवाह दिखाने के लिए –

+0

वेबसक्वेंसडिआग्राम इन आरेखों को आकर्षित करने का एक शानदार तरीका है। –

2

अगर मैं इसे सही ढंग से समझते हैं कि आप अपनी परियोजना/उत्पाद के लिए दस्तावेज़ बनाने की जरूरत का उदाहरण है, है ना की जगह?

शायद MS Visio आपकी आवश्यकताओं के लिए उपयोगी हो सकता है। यह प्रलेखन सॉफ़्टवेयर है जिसका उपयोग डेटा प्रवाह आरेख (डीएफडी), आदि,

बनाने के लिए किया जाता है, हो सकता है कि आप इसे जावास्क्रिप्ट/jQuery कोड मॉडलिंग के लिए उपयोग कर सकें।

जहां तक ​​मुझे पता है कि यह दस्तावेज़ीकरण के लिए अच्छा है।

इसे आज़माएं या इसी तरह की चीजों की खोज करें।

मुझे आशा है कि यह सहायक होगा।

इस तरह एक और है, Rational Rose

+0

हाय, इसके लिए धन्यवाद, लेकिन मेरे पास आरेख बनाने के लिए एक उपकरण है, मैं बस कुछ प्रकार के "नोटेशन" की तलाश कर रहा हूं, मानक अगर आपको पसंद है। –

+0

तब प्रवाह चार्ट और अनुक्रम आरेखों के लिए जाने के लिए बेहतर "जून आर" के रूप में कहा गया – srinivas

1

सरल अनुक्रम आरेखों के लिए, मैंने हाल ही में websequencediagrams.com की खोज की और यह मेरी आवश्यकताओं के लिए बहुत अच्छा है। सरल, अनुकूलन और एम्बेड करने योग्य। कोशिश करो!

संबंधित मुद्दे