Biblioteksvägledning
Den här vägledningen ger rekommendationer för utvecklare att skapa .NET-bibliotek av hög kvalitet. Den här dokumentationen fokuserar på vad och varför när du skapar ett .NET-bibliotek, inte hur.
Aspekter av .NET-bibliotek av hög kvalitet:
- Inkluderande – Bra .NET-bibliotek strävar efter att stödja många plattformar, programmeringsspråk och program.
- Stabil – Bra .NET-bibliotek samexisterar i .NET-ekosystemet och körs i program som skapats med många bibliotek.
- Utformat för att utvecklas – .NET-bibliotek bör förbättras och utvecklas med tiden, samtidigt som befintliga användare får stöd.
- Debuggable – .NET-bibliotek bör använda de senaste verktygen för att skapa en bra felsökningsupplevelse för användare.
- Betrodd – .NET-bibliotek har utvecklarnas förtroende genom att publicera till NuGet med hjälp av rekommenderade säkerhetsmetoder.
Typer av rekommendationer
Varje artikel innehåller fyra typer av rekommendationer: Do, Consider, Avoid och Do not. Typen av rekommendation anger hur starkt den ska följas.
Du bör nästan alltid följa en Do-rekommendation . Ett exempel:
✔️ Distribuera biblioteket med hjälp av ett NuGet-paket.
Å andra sidan bör överväga rekommendationer i allmänhet följas, men det finns legitima undantag till regeln och du bör inte må dåligt över att inte följa vägledningen:
✔️ ÖVERVÄG att använda SemVer 2.0.0 för att version ditt NuGet-paket.
Undvik rekommendationer nämner saker som i allmänhet inte är en bra idé, men att bryta mot regeln är ibland logiskt:
❌ UNDVIK NuGet-paketreferenser som kräver en exakt version.
Och slutligen, Inte rekommendationer anger något du nästan aldrig bör göra:
❌ PUBLICERA INTE starkt namngivna och icke-starka namngivna versioner av biblioteket. Exempelvis Contoso.Api och Contoso.Api.StrongNamed.