Ekstensi Cool Visual Studio memiliki beberapa fitur utama yang membedakannya dari yang lain. Mereka terlihat dan benar-benar dipikirkan dengan baik, fungsional dan dapat diandalkan. Selain itu, mereka melakukan apa yang seharusnya, ke tingkat keunggulan dan sesuai dengan fungsi internal Visual Studio.
Untuk mempermudah penulisan ekstensi yang baik, kami bekerja dengan komunitas untuk mengembangkan daftar periksa sederhana. Bahkan ada
templat masalah GitHub yang dapat Anda gunakan. Dalam artikel ini, kami akan membahas 9 aturan ekspansi keren. Detail di bawah potongan.
Aturannya
Daftar berikut ini tidak berurutan. Ingatlah untuk mengikuti semua aturan untuk hasil terbaik.
Aturan 1: Patuhi aturan cakupan
Tambahkan paket NuGet
Microsoft.VisualStudio.SDK.Analyzers ke proyek VSIX Anda. Ini akan membantu Anda mengidentifikasi dan menyelesaikan kesalahan threading umum.
Aturan 2: Tambahkan Ikon Kualitas Tinggi
Semua ekstensi harus memiliki ikon yang terkait dengannya. Pastikan ikonnya adalah file .png berkualitas tinggi dengan resolusi 128 × 128 piksel dan DPI 96 atau lebih. Setelah menambahkan ikon ke proyek VSIX, daftarkan di file .vsixmanifest sebagai ikon dan gambar pratinjau. Visual Studio Marketplace menggunakan ikon yang lebih besar dan ikon Anda akan berubah secara dinamis saat ditampilkan di Visual Studio.
Aturan 3: Judul dan Deskripsi
Studi menunjukkan bahwa pengguna lebih sering memasang ekstensi dengan nama deskriptif pendek dan informasi yang tepat tentang mereka. Pastikan nama tersebut menangkap esensi dari apa yang dilakukan ekstensi. Deskripsi dalam file .vsixmanifest seharusnya menciptakan harapan tentang apa yang dilakukan ekstensi. Secara total, uraian singkat tentang masalah apa yang dipecahkan ekstensi dan fungsinya.
Aturan 4: Tulis Deskripsi Marketplace yang Baik
Ini adalah salah satu hal terpenting yang harus Anda lakukan untuk membuat ekspansi Anda sukses. Deskripsi yang baik terdiri dari:
- Cuplikan layar / GIF apa yang akan ditambahkan oleh ekstensi
- Deskripsi fitur terperinci
- Tautan ke detail, jika perlu
Aturan 5: Tunjukkan lisensi
Lisensi ditampilkan di Marketplace, di penginstal VSIX, dan di kotak dialog Extensions Manager. Selalu tentukan lisensi untuk menciptakan harapan bagi pengguna. Pertimbangkan untuk menggunakan
selectalicense.com untuk menemukan lisensi yang tepat. Alasan aturan ini adalah untuk menyelesaikan ambiguitas apa pun, yang penting bagi banyak pengguna Visual Studio.
Aturan 6: Tambahkan pemberitahuan privasi
Jika ekstensi mengumpulkan data, seperti telemetri, tambahkan catatan tentang ini dalam deskripsi.
Aturan 7: Gunakan Alat yang DikenalMonik jika Mungkin
Visual Studio hadir dengan ribuan ikon yang tersedia dalam koleksi The
FamousMonikers . Saat menambahkan ikon ke tombol, periksa: mungkin Anda dapat menggunakan ikon FamousMonikers yang ada, karena mereka adalah bagian dari bahasa desain yang akrab bagi pengguna Visual Studio. Berikut ini adalah
daftar lengkap
dari FamousMonikers , dan Anda juga dapat menggunakan ekstensi
Explorer FamousMonikers untuk menemukan yang sesuai dengan skrip Anda.
Aturan 8: Buat rasa ekstensi asli
Ikuti pola dan prinsip desain yang sama yang digunakan Visual Studio sendiri. Ini membuat ekstensi alami bagi pengguna. Ini juga mengurangi gangguan yang disebabkan oleh antarmuka pengguna yang dirancang dengan buruk. Pastikan bahwa semua tombol, menu, bilah alat, dan jendela alat terlihat secara default hanya jika pengguna berada dalam konteks yang tepat untuk menggunakannya. Ada beberapa aturan:
- Jangan pernah menambahkan menu tingkat atas baru (di sebelah File, Edit, dll.)
- Tidak ada tombol, menu, atau bilah alat harus terlihat dalam konteks yang bukan miliknya.
- Jika Anda memerlukan pengisian otomatis (kemungkinan besar tidak), lakukan sesegera mungkin.
- Gunakan VisibilityConstraints untuk mengubah visibilitas perintah alih-alih mengandalkan pemuatan otomatis
Aturan 9: Gunakan rentang versi yang benar
Mungkin tergoda untuk mendukung versi Visual Studio hingga Visual Studio 2010 sehingga semua orang dapat menggunakan ekstensi baru Anda. Masalahnya adalah Anda tidak bisa lagi menggunakan API yang diperkenalkan lebih lama dari versi lama yang didukung ekstensi. Seringkali API baru ini penting dan membantu meningkatkan kinerja dan keandalan ekstensi dan Visual Studio itu sendiri.
Berikut adalah pedoman kami untuk memutuskan versi Visual Studio mana yang akan didukung:
- Hanya mendukung Visual Studio versi sebelumnya dan saat ini - jika memungkinkan, jangan mendukung versi yang lebih lama
- Jangan menentukan kisaran versi yang tersedia. Sebagai contoh. [16.0,). Cari tahu lebih lanjut tentang versi di sini .
Pendapat anda
Apa pendapat Anda tentang daftar periksa ini? Apakah Anda setuju dengan aturan? Silakan bagikan pemikiran Anda di bawah ini di komentar atau di
repositori GitHub . Saya harap daftar periksa ini membantu Anda membuat ekstensi keren yang akan menjadi sangat populer.