Panduan pustaka

Panduan ini memberikan rekomendasi bagi pengembang untuk membuat pustaka .NET berkualitas tinggi. Dokumentasi ini berfokus pada apa dan mengapa saat membangun pustaka .NET, bukan bagaimana.

Aspek pustaka .NET berkualitas tinggi:

• Inklusif - Pustaka .NET yang baik berusaha untuk mendukung banyak platform, bahasa pemrogram, dan aplikasi.
• Stabil - Pustaka .NET yang bagus bisa berdampingan dalam ekosistem .NET, berjalan dalam aplikasi yang dibangun dengan banyak pustaka.
• Dirancang untuk berkembang - pustaka .NET harus terus meningkat dan berkembang dari waktu ke waktu, sambil mendukung pengguna yang ada.
• Dapat di-debug - Pustaka .NET harus menggunakan alat terbaru untuk menciptakan pengalaman penelusuran kesalahan yang hebat bagi pengguna.
• Tepercaya - pustaka .NET memiliki kepercayaan pengembang dengan menerbitkan ke NuGet menggunakan praktik terbaik keamanan.

Mulai

Jenis rekomendasi

Setiap artikel menyajikan empat jenis rekomendasi: Lakukan, Pertimbangkan, Hindari, dan Jangan. Jenis rekomendasi menunjukkan seberapa kuat aturan harus diikuti.

Anda hampir selalu harus mengikuti rekomendasi Lakukan. Contohnya:

✔️ Distribusikan pustaka Anda menggunakan paket NuGet.

Di sisi lain, rekomendasi Pertimbangkan umumnya harus diikuti, tetapi ada pengecualian yang sah untuk aturan dan Anda seharusnya tidak merasa bersalah jika tidak mengikuti panduan:

✔️ PERTIMBANGKAN menggunakan SemVer 2.0.0 untuk membuat versi paket NuGet Anda.

Rekomendasi Hindari yang menyebutkan hal-hal yang umumnya bukan ide yang baik, tetapi melanggar aturan tersebut terkadang masuk akal:

❌ HINDARI referensi paket NuGet yang menuntut versi yang spesifik.

Dan akhirnya, rekomendasi Jangan menunjukkan sesuatu yang hampir tidak boleh Anda lakukan:

❌ JANGAN menerbitkan versi pustaka Anda yang bernama kuat dan tidak diberi nama yang kuat. Misalnya, Contoso.Api dan Contoso.Api.StrongNamed.

Berikutnya