महान दृश्य स्टूडियो एक्सटेंशन लिखने के लिए चेकलिस्ट

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

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

नियम

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

नियम 1: थ्रेडिंग नियमों का पालन करें

अपने VSIX प्रोजेक्ट में Microsoft.VisualStudio.SDK.Analyzers NuGet पैकेज जोड़ें। यह आपको थ्रेडिंग के बारे में सर्वोत्तम प्रथाओं के सामान्य उल्लंघनों को खोजने और ठीक करने में मदद करेगा।

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

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

नियम 3: नाम और विवरण

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

नियम 4: अच्छे मार्केटप्लेस का वर्णन लिखें

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

• एक्सटेंशन द्वारा जोड़े गए UI के स्क्रीनशॉट / एनिमेटेड GIF
• व्यक्तिगत विशेषताओं का विस्तृत विवरण
• लागू होने पर अधिक जानकारी के लिए लिंक

नियम 5: लाइसेंस जोड़ें

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

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

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

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

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

नियम 8: इसे वीएस के मूल निवासी महसूस करें

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

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

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

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

• विजुअल स्टूडियो के केवल पिछले और वर्तमान संस्करण का समर्थन करें - यदि संभव हो तो पुराने संस्करणों का समर्थन न करें
• एक ओपन एंडेड वर्जन रेंज निर्दिष्ट न करें। जैसे [१६.०,)। संस्करण श्रेणियों के बारे में अधिक जानें।

आपके विचार

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