विजुअल स्टूडियो के लिए 9 कूल एक्सटेंशन नियम

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

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

नियम

निम्नलिखित सूची क्रम में नहीं है। सर्वोत्तम परिणामों के लिए सभी नियमों का पालन करना याद रखें।

नियम 1: कवरेज के नियमों का पालन करें

अपने VSIX प्रोजेक्ट में Microsoft.VisualStudio.SDK.Analyzers NuGet पैकेज जोड़ें। यह आपको सामान्य थ्रेडिंग त्रुटियों को पहचानने और हल करने में मदद करेगा।

नियम 2: उच्च गुणवत्ता आइकन जोड़ें

सभी एक्सटेंशन में उनके साथ संबंधित एक आइकन होना चाहिए। सुनिश्चित करें कि आइकन एक उच्च-गुणवत्ता वाली .png फ़ाइल है जिसका रिज़ॉल्यूशन 128 × 128 पिक्सेल है और 96 या अधिक का DPI है। VSIX प्रोजेक्ट में आइकन जोड़ने के बाद, इसे .vsixmanifest फ़ाइल में आइकन और पूर्वावलोकन छवि के रूप में पंजीकृत करें। विजुअल स्टूडियो मार्केटप्लेस एक बड़े आइकन का उपयोग करता है और विजुअल स्टूडियो में प्रदर्शित होने पर आपका गतिशील रूप से बदल जाएगा।

नियम 3: शीर्षक और विवरण

अध्ययन से पता चलता है कि उपयोगकर्ता अधिक बार संक्षिप्त वर्णनात्मक नाम और उनके बारे में सटीक जानकारी के साथ एक्सटेंशन स्थापित करते हैं। सुनिश्चित करें कि नाम विस्तार क्या करता है का सार कैप्चर करता है। .Vsixmanifest फ़ाइल का विवरण एक्सटेंशन क्या करता है के बारे में अपेक्षाएँ बनाना चाहिए। कुल मिलाकर, विस्तार का क्या हल है और इसके कार्य क्या हैं, इसका संक्षिप्त विवरण।

नियम 4: एक अच्छा बाज़ार विवरण लिखें

यह सबसे महत्वपूर्ण चीजों में से एक है जिसे आपको अपने विस्तार को सफल बनाने के लिए करना चाहिए। एक अच्छे वर्णन में निम्न शामिल हैं:

• स्क्रीनशॉट / GIFs जो एक्सटेंशन द्वारा जोड़ा जाएगा
• विस्तृत विवरण
• विवरण के लिए लिंक, यदि आवश्यक हो

नियम 5: लाइसेंस का संकेत दें

लाइसेंस मार्केटप्लेस में, वीएसआईएक्स इंस्टॉलर में और एक्सटेंशन्स मैनेजर डायलॉग बॉक्स में प्रदर्शित होता है। उपयोगकर्ताओं के लिए अपेक्षाएँ बनाने के लिए हमेशा लाइसेंस निर्दिष्ट करें। सही लाइसेंस खोजने के लिए choosealicense.com का उपयोग करने पर विचार करें। इस नियम का कारण किसी भी अस्पष्टता को हल करना है, जो कई विज़ुअल स्टूडियो उपयोगकर्ताओं के लिए महत्वपूर्ण है।

नियम 6: एक गोपनीयता नोटिस जोड़ें

यदि एक्सटेंशन डेटा एकत्र करता है, जैसे कि टेलीमेट्री, विवरण में इस बारे में एक नोट जोड़ें।

नियम 7: जहां संभव हो, ज्ञात निर्माता का उपयोग करें

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

नियम 8: देशी विस्तार की भावना पैदा करें

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

• नया शीर्ष-स्तरीय मेनू (फ़ाइल, संपादन, आदि के बगल में) कभी न जोड़ें
• कोई बटन, मेनू या टूलबार संदर्भों में दिखाई नहीं देना चाहिए, जिसमें वे नहीं हैं।
• यदि आपको ऑटोलैड (सबसे अधिक संभावना नहीं) की आवश्यकता है, तो इसे जल्द से जल्द करें।
• स्वचालित लोडिंग पर निर्भर रहने के बजाय कमांड दृश्यता को टॉगल करने के लिए VisibilityConstraints का उपयोग करें

नियम 9: सही संस्करण श्रेणियों का उपयोग करें

यह Visual Studio 2010 तक Visual Studio के संस्करणों का समर्थन करने के लिए लुभावना हो सकता है ताकि हर कोई आपके नए एक्सटेंशन का उपयोग कर सके। समस्या यह है कि अब आप पुराने संस्करण की तुलना में बाद में शुरू किए गए एपीआई का उपयोग नहीं कर सकते जो एक्सटेंशन का समर्थन करता है। अक्सर ये नए एपीआई महत्वपूर्ण होते हैं और आपके एक्सटेंशन और विज़ुअल स्टूडियो दोनों के ही प्रदर्शन और विश्वसनीयता को बेहतर बनाने में मदद करते हैं।

यह देखने के लिए हमारे दिशानिर्देश हैं कि समर्थन करने के लिए विजुअल स्टूडियो के कौन से संस्करण हैं:

• विजुअल स्टूडियो के केवल पिछले और वर्तमान संस्करणों का समर्थन करें - यदि संभव हो तो, पुराने संस्करणों का समर्थन न करें
• उपलब्ध संस्करणों की सीमा निर्दिष्ट न करें। उदाहरण के लिए। [16.0)। यहाँ संस्करणों के बारे में अधिक जानकारी प्राप्त करें ।

आपकी राय

इस चेकलिस्ट से आप क्या समझते हैं? क्या आप नियमों से सहमत हैं? कृपया नीचे टिप्पणी या GitHub भंडार में अपने विचार साझा करें। मुझे उम्मीद है कि चेकलिस्ट आपको शांत एक्सटेंशन बनाने में मदद करती है जो वास्तव में लोकप्रिय हो जाएगी।