تشترك ملحقات Visual Studio الرائعة مع بعض الميزات الرئيسية التي تميزها عن الباقي. إنهم يبدون ويشعرون بصياغة جيدة ، وهم مؤهلون وموثوقون ، ويفعلون ما يعلنونه إلى حد الكمال ، ويمتزجون بشكل طبيعي بين ميزات Visual Studio الخاصة.
لتسهيل كتابة إضافات كبيرة ، عملنا مع مجتمع القابلية للتوسعة للتوصل إلى قائمة تحقق بسيطة لمتابعة. يوجد حتى
قالب مشكلة في GitHub يمكنك استخدامه حتى تتذكر أن تتصفح قائمة التحقق.
قواعد
القائمة التالية ليست في ترتيب محدد. تذكر أن تكمل جميع العناصر للحصول على أفضل النتائج.
المادة 1: الالتزام بقواعد الترابط
أضف حزمة
Microsoft.VisualStudio.SDK.Analyzers إلى مشروع VSIX الخاص بك. هذا سيساعدك على اكتشاف وإصلاح الانتهاكات الشائعة لأفضل الممارسات المتعلقة بالخيوط.
القاعدة 2: إضافة أيقونة عالية الجودة
يجب أن تحتوي جميع الإضافات على أيقونة مرتبطة بها. تأكد من أن الرمز هو ملف بتنسيق .png عالي الجودة بحجم 128 × 128 بكسل في 96 نقطة في البوصة أو أكثر. بعد إضافة الرمز إلى مشروع VSIX الخاص بك ، قم بتسجيله في ملف .vsixmanifest كصورة معاينة ومعاينة. يستخدم Visual Studio Marketplace الرمز الأكبر وسيتم تغيير حجمه ديناميكيًا عندما يظهر داخل Visual Studio.
المادة 3: الاسم والوصف
تشير الدراسات إلى أنه من المرجح أن يقوم المستخدمون بتثبيت الامتدادات بأسماء قصيرة وصفية وأوصاف دقيقة. تأكد من أن الاسم يعكس جوهر ما تقوم به الإضافة. يجب أن يحدد الوصف في ملف .vsixmanifest التوقعات فيما يتعلق بما يفعله الامتداد. لذلك ، هناك إشارة مختصرة إلى المشكلات التي تحلها والسمات الرئيسية التي لها.
المادة 4: اكتب وصفًا جيدًا للسوق
هذا هو أحد أهم الأشياء التي يجب عليك القيام بها لجعل امتدادك ناجحًا. وصف جيد يتكون من:
- تمت إضافة لقطات شاشة / صور GIF متحركة لواجهة المستخدم بواسطة الإضافة
- وصف مفصل للميزات الفردية
- روابط لمزيد من التفاصيل إن وجدت
المادة 5: إضافة الترخيص
يكون الترخيص مرئيًا على Marketplace وفي مُثبّت VSIX وفي مربع الحوار Extensions Manager. حدد دائمًا ترخيصًا لضبط التوقعات للمستخدمين. فكر في استخدام
choosealicense.com للمساعدة في العثور على الترخيص المناسب لك. سبب هذه القاعدة هو إزالة أي غموض ، وهو أمر مهم للعديد من مستخدمي Visual Studio.
المادة 6: إضافة إشعار الخصوصية
إذا قام الامتداد بجمع بيانات مثل القياس عن بُعد أو بأي طريقة أخرى يتصل بنقطة نهاية بعيدة ، أضف ملاحظة عنها في الوصف.
المادة 7: استخدام KnownMonikers عندما يكون ذلك ممكنا
يأتي Visual Studio مع الآلاف من الرموز المتوفرة في مجموعة
KnownMonikers . عند إضافة رموز إلى أزرار الأوامر ، معرفة ما إذا كان يمكنك استخدام رموز KnownMonikers الموجودة نظرًا لأنها جزء من لغة تصميم مألوفة لدى مستخدمي Visual Studio. إليك
قائمة كاملة
من KnownMonikers والاستيلاء على ملحق
KnownMonikers Explorer للعثور على المناسب لسيناريوهاتك.
المادة 8: اجعلها تشعر بأنك أصلي لدى VS
اتبع نفس أنماط التصميم والمبادئ التي يستخدمها Visual Studio نفسه. هذا يجعل امتداد يشعر طبيعي للمستخدمين. كما أنه يقلل من الانحرافات الناجمة عن سوء تصميم واجهة المستخدم. تأكد من أن جميع الأزرار والقوائم وأشرطة الأدوات ونوافذ الأدوات مرئية فقط بشكل افتراضي عندما يكون المستخدم في السياق الصحيح لاستخدامها. هناك بعض القواعد التي يجب اتباعها:
- لا تقم أبدًا بإضافة قائمة جديدة ذات مستوى عالٍ (بجوار ملف ، تحرير ، إلخ.)
- يجب ألا تكون هناك أزرار وقوائم وأشرطة أدوات مرئية في السياقات التي لا تنطبق عليها
- إذا كان التحميل التلقائي ضروريًا (ربما لا يكون ذلك) ، فقم بذلك في وقت متأخر قدر الإمكان.
- استخدم VisibilityConstrict لتبديل رؤية الأوامر بدلاً من الاعتماد على التحميل التلقائي
المادة 9: استخدام نطاقات الإصدار المناسب
قد يكون من المغري دعم إصدارات Visual Studio طوال فترة العودة إلى Visual Studio 2010 للتأكد من أنه يمكن للجميع استخدام الملحق الجديد. المشكلة في ذلك هي أنه من خلال القيام بذلك ، لم يعد من الممكن استخدام أي واجهات برمجة التطبيقات المقدمة بعد ذلك الحد الأدنى من الإصدار الذي يدعمه الامتداد. غالبًا ما تكون واجهات برمجة التطبيقات الجديدة مهمة وتساعد على تحسين الأداء والموثوقية لكل من ملحقك وكذلك Visual Studio نفسه.
فيما يلي توصياتنا لتحديد إصدارات Visual Studio لدعمها:
- دعم فقط الإصدار السابق والحالي من Visual Studio - لا تدعم الإصدارات القديمة إن أمكن
- لا تحدد نطاق إصدار مفتوح. على سبيل المثال [16.0 ،). معرفة المزيد عن نطاقات الإصدار .
أفكارك
ما رأيك في قائمة المراجعة هذه؟ هل توافق على القواعد؟ يرجى إعلامنا بأفكارك في التعليقات أدناه أو في
GitHub repo لقائمة المراجعة . آمل أن يجعل ذلك من الأسهل قليلاً إعطاء امتداداتك هذا الشيء القليل الإضافي الذي يميزها عن الباقي.