जटिल फ्लोचार्ट या क्रमबद्ध समय रेखा जैसे विशिष्ट वास्तुकला लेआउट में डुबकी लगाने से पहले, यह समझना आवश्यक है कि इसके नियम क्या हैं जो इसके नियंत्रण करते हैंमेरमैड प्लेबुक. मेरमैड एक साफ, बहुत अनुकूल टेक्स्ट नोटेशन प्रणाली पर निर्भर करता है। जब आप समझ लेते हैं कि इंजन कैनवास प्रकार को कैसे शुरू करता है, संरचनात्मक घटकों के नाम रखता है और दिशात्मक तीरों को कैसे रास्ता देता है, तो किसी भी जटिल सिस्टम लेआउट को लिखना पूरी तरह से प्राकृतिक हो जाता है।
यह त्वरित परिचय विश्व के लगभग हर मेरमैड डायग्राम प्रकार में लागू होने वाले सार्वभौमिक संरचनात्मक सिंटैक्स तकनीकों को कवर करता है।
1. अनिवार्य डायग्राम प्रकार के लिए लपेटना
मेरमैड कोड का हर एक ब्लॉक को बहुत पहली पंक्ति पर अपने डायग्राम आर्काइटाइप को स्पष्ट रूप से घोषित करके शुरू करना चाहिए। यह VPasCode पार्सर को ठीक यह बताता है कि आपके प्रीव्यू कैनवास में कौन सा संरचनात्मक इंजन चालू करना है:
graph TD— ऊपर से नीचे व्यवस्थित फ्लोचार्ट लेआउट निर्दिष्ट करता है।sequenceDiagram— क्रमबद्ध रनटाइम टाइमलाइन चार्ट निर्दिष्ट करता है।classDiagram— संरचनात्मक ऑब्जेक्ट-ओरिएंटेड सॉफ्टवेयर ब्लूप्रिंट निर्दिष्ट करता है।
अन्य टेक्स्ट-टू-डायग्राम इंजन के विपरीत, मेरमैड को अंतिम टैग की आवश्यकता नहीं होती है। पार्सर सिर्फ पहली पंक्ति पर संरचनात्मक घोषणा पढ़ता है और अपने कोड ब्लॉक कंटेनर के नीचे सीधे निर्मित सब कुछ संकलित करता है।
2. तत्वों की घोषणा: आईडी बनाम प्रदर्शन लेबल
जब आप सॉफ्टवेयर सिस्टम के मॉडलिंग करते हैं, तो आप विभिन्न संरचनात्मक तत्व जैसे घटक, डेटाबेस या माइक्रोसर्विसेज बनाएंगे। मेरमैड में, आप एक तत्व की घोषणा एक छोटे, आ inter अल्फान्यूमेरिक आईडी को परिभाषित करके करते हैं, जिसके तुरंत बाद एक ब्रैकेट शैली होती है जो इसके दृश्य आकार को नियंत्रित करती है, और एक उपयोगकर्ता-अनुकूल प्रदर्शन नाम:
microservice_id[पेमेंट प्रोसेसिंग एपीआई]
db_id[(उपयोगकर्ता लेनदेन एसक्यूएल)]क्यों यह एक बेस्ट प्रैक्टिस है: एक छोटे, साफ आ inter आईडी (जैसेmicroservice_id) बाद में संबंध रेखाएं खींचने को बहुत तेज करता है। यदि आपको कभी ग्राहक के सामने वाले लेबल को “पेमेंट प्रोसेसिंग एपीआई” से “ग्लोबल चेकआउट सर्विस” में बदलने की आवश्यकता हो, तो आपको बस उस एक पंक्ति में इसे संपादित करना होगा जहां इसकी घोषणा की गई है, अपने स्क्रिप्ट के लगभग दसों पंक्तियों को अपडेट करने के बजाय।
3. संबंध तीरों और दिशात्मक रूटिंग को समझना
सिस्टम नोड्स के बीच कनेक्शन डैश (-), बराबर के चिह्न (=), और तीर ब्रैकेट (>) के संयोजन का उपयोग करके खींचे जाते हैं। आपकी रेखाओं की शैली आपको स्वचालित लेआउट इंजन द्वारा आपके डायग्राम को कैसे स्केल करने के बारे में अप्रत्यक्ष नियंत्रण देती है:
A --> Bतत्व A से सीधे तत्व B की ओर एक मानक दिशात्मक त стрेला खींचता है।A --- Bबिना तीर के एक समतल, अदिश लिंक लाइन खींचता है, जो सरल संबंधों के लिए आदर्श है।A -.-> Bएक बिंदुवत निर्भरता रेखा बनाता है, जो असमान समय संबंधों या नेटवर्क वेबहुक्स को इंगित करने के लिए उद्योग मानक है।A ==> Bएक मोटी, मोटी संयोजन रेखा बनाता है, जो मुख्य डेटा प्रसंस्करण मार्गों या महत्वपूर्ण बुनियादी ढांचे के संबंधों को उजागर करने के लिए आदर्श है।
4. सीधे संदर्भ जोड़ना: लेबल और कोड कमेंट्स
स्पष्ट दस्तावेज़ीकरण अपनी दृश्य रेखाओं और पाठ स्क्रिप्ट्स के चारों ओर उचित संदर्भ रखने पर बहुत निर्भर करता है:
संबंध रेखाओं को लेबल करना
आप किसी भी संबंध रेखा के सीधे व्याख्यात्मक पाठ जोड़ सकते हैं दो डैश के बीच पाठ स्ट्रिंग डालकर, या एक पाइप चरित्र (|पाठ|) अपने संबंध मैपिंग के तुरंत बाद:
client_id -- "HTTPS POST /v1/checkout" --> api_id
client_id --> |HTTPS POST /v1/checkout| api_idकोड कमेंट्स लिखना
यदि आप अपने स्क्रिप्ट फ़ाइल के अंदर प्रशासनिक नोट, डिज़ाइन क्रेडिट या वास्तुकला व्याख्या छोड़ना चाहते हैं बिना कैनवास पर कोई दृश्य बॉक्स बनाए, तो डबल प्रतिशत चिह्नों का उपयोग करें (%%). इससे इंजन को उस पंक्ति को पूरी तरह से छोड़ने के लिए कहता है:
%% TODO: हमें इस सीमा बॉक्स को देवोप्स माइग्रेशन पूरा होने के बाद अपडेट करने की आवश्यकता है
[पुराना मोनोलिथ] --> [नया माइक्रोसर्विस]