Ekstensi Visual Studio yang luar biasa memiliki beberapa fitur utama yang membedakannya dari yang lain. Mereka terlihat dan merasa dibuat dengan baik, performan dan dapat diandalkan, melakukan apa yang mereka iklankan dengan sempurna, dan berbaur secara alami di antara fitur-fitur Visual Studio sendiri.
Untuk membuatnya lebih mudah untuk menulis ekstensi yang hebat, kami telah bekerja dengan komunitas ekstensibilitas untuk membuat daftar periksa sederhana untuk diikuti. Bahkan ada
templat masalah GitHub yang dapat Anda gunakan sehingga Anda ingat untuk memeriksa daftar periksa.
Aturan
Daftar berikut ini tanpa urutan tertentu. Ingatlah untuk menyelesaikan semua item untuk hasil terbaik.
Aturan 1: Patuhi aturan threading
Tambahkan paket NuGet
Microsoft.VisualStudio.SDK.Analyzers ke proyek VSIX Anda. Ini akan membantu Anda menemukan dan memperbaiki pelanggaran umum praktik terbaik terkait threading.
Aturan 2: Tambahkan ikon berkualitas tinggi
Semua ekstensi harus memiliki ikon yang terkait dengannya. Pastikan ikonnya adalah file .png berkualitas tinggi dengan ukuran 128 × 128 piksel dalam 96 DPI atau lebih. Setelah menambahkan ikon ke proyek VSIX Anda, daftarkan di file .vsixmanifest sebagai ikon dan gambar Pratinjau. Visual Studio Marketplace menggunakan ikon yang lebih besar dan akan diubah ukurannya secara dinamis saat ditampilkan di dalam Visual Studio.
Aturan 3: Nama dan deskripsi
Studi menunjukkan bahwa pengguna lebih cenderung memasang ekstensi dengan nama pendek dan deskriptif serta deskripsi yang akurat. Pastikan nama mencerminkan esensi dari apa yang dilakukan ekstensi. Deskripsi dalam file .vsixmanifest harus menetapkan harapan tentang apa yang dilakukan ekstensi. Jadi, penyebutan singkat tentang masalah apa yang dipecahkan dan fitur utama apa yang dimilikinya adalah kuncinya.
Aturan 4: Tulis deskripsi Marketplace yang baik
Ini adalah salah satu hal terpenting yang harus Anda lakukan untuk membuat ekstensi Anda berhasil. Deskripsi yang baik terdiri dari:
- Screenshot / animasi GIF UI yang ditambahkan oleh ekstensi
- Penjelasan terperinci tentang masing-masing fitur
- Tautan ke detail lebih lanjut jika berlaku
Aturan 5: Tambahkan lisensi
Lisensi terlihat di Marketplace, di penginstal VSIX, dan di dialog Extensions Manager. Selalu tentukan lisensi untuk menetapkan harapan bagi pengguna. Pertimbangkan untuk menggunakan
selectalicense.com untuk membantu menemukan lisensi yang tepat untuk Anda. Alasan aturan ini adalah untuk menghapus ambiguitas, yang penting bagi banyak pengguna Visual Studio.
Aturan 6: Tambahkan pemberitahuan privasi
Jika ekstensi mengumpulkan data seperti telemetri atau dengan cara lain berkomunikasi dengan titik akhir jarak jauh, tambahkan catatan tentang hal itu dalam deskripsi.
Aturan 7: Gunakan dikenalMonikers bila memungkinkan
Visual Studio dikirimkan dengan ribuan ikon yang tersedia di koleksi
DiketahuiMonikers . Saat menambahkan ikon ke tombol perintah, lihat apakah Anda dapat menggunakan ikon FamousMonikers yang sudah ada karena merupakan bagian dari bahasa desain yang akrab bagi pengguna Visual Studio. Berikut adalah
daftar lengkap
dari FamousMonikers dan ambil ekstensi
Explorer the
FamousMonikers untuk menemukan yang tepat untuk skenario Anda.
Aturan 8: Buatlah terasa asli untuk VS
Ikuti pola dan prinsip desain yang sama yang digunakan Visual Studio sendiri. Ini membuat ekstensi terasa alami bagi pengguna. Ini juga mengurangi gangguan yang disebabkan oleh UI yang dirancang dengan buruk. Pastikan bahwa semua tombol, menu, bilah alat, dan jendela alat hanya terlihat secara default ketika pengguna berada dalam konteks yang tepat untuk menggunakannya. Ada beberapa aturan praktis yang harus diikuti:
- Jangan pernah menambahkan menu tingkat atas baru (di sebelah File, Edit, dll.)
- Tidak ada tombol, menu, dan bilah alat yang terlihat dalam konteks yang tidak berlaku
- Jika memuat otomatis diperlukan (mungkin tidak), lakukan selambat mungkin.
- Gunakan VisibilityConstraints untuk mengaktifkan visibilitas perintah alih-alih mengandalkan beban otomatis
Aturan 9: Gunakan rentang versi yang tepat
Mungkin tergoda untuk mendukung versi Visual Studio sepanjang perjalanan kembali ke Visual Studio 2010 untuk memastikan bahwa semua orang dapat menggunakan ekstensi baru Anda. Masalahnya adalah dengan melakukannya, tidak mungkin lagi menggunakan API apa pun yang diperkenalkan setelah versi minimum yang didukung ekstensi. Seringkali, API baru itu penting dan membantu meningkatkan kinerja dan keandalan ekstensi Anda dan juga Visual Studio itu sendiri.
Berikut adalah rekomendasi kami untuk memutuskan versi apa yang didukung Visual Studio:
- Mendukung hanya versi Visual Studio sebelumnya dan saat ini - jangan mendukung versi yang lebih lama jika memungkinkan
- Jangan menentukan rentang versi terbuka. Misalnya [16.0,). Pelajari lebih lanjut tentang rentang versi .
Pikiran Anda
Apa pendapat Anda tentang daftar periksa ini? Apakah Anda setuju dengan aturan? Beri tahu kami pendapat Anda dalam komentar di bawah atau di
repo GitHub untuk daftar periksa . Saya harap ini membuatnya sedikit lebih mudah untuk memberikan ekstensi Anda sesuatu yang ekstra yang membedakannya dari yang lain.