Condividi tramite

Linee guida per la libreria

Queste indicazioni forniscono raccomandazioni per gli sviluppatori per creare librerie .NET di alta qualità. Questa documentazione è incentrata su cosa e perché quando si compila una libreria .NET, non sul modo in cui.

Aspetti delle librerie .NET di alta qualità:

  • Inclusivo : librerie .NET valide si sforzano di supportare molte piattaforme, linguaggi di programmazione e applicazioni.
  • Stabile : le librerie .NET valide coesistono nell'ecosistema .NET, in esecuzione in applicazioni compilate con molte librerie.
  • Progettato per evolversi : le librerie .NET devono migliorare ed evolversi nel tempo, supportando gli utenti esistenti.
  • Debug: le librerie .NET devono usare gli strumenti più recenti per creare un'esperienza di debug ottimale per gli utenti.
  • Attendibile : le librerie .NET hanno attendibilità per gli sviluppatori pubblicando in NuGet usando le procedure consigliate per la sicurezza.

Per iniziare

Tipi di raccomandazioni

Ogni articolo presenta quattro tipi di raccomandazioni: Do, Consider, Avoid e Do not. Il tipo di raccomandazione indica con quale fermezza debba essere seguito.

Dovresti quasi sempre seguire una raccomandazione Do. Per esempio:

✔️ DO distribuisci la tua libreria utilizzando un pacchetto NuGet.

D'altra parte, Considera che è generalmente consigliabile seguire le raccomandazioni, ma esistono legittime eccezioni alla regola e non dovresti sentirti in colpa se non segui le indicazioni.

✔️ È consigliabile usare SemVer 2.0.0 per la versione del pacchetto NuGet.

Evitare le raccomandazioni menzionano cose che di solito non sono una buona idea, ma rompere la regola a volte ha senso:

❌ EVITARE riferimenti al pacchetto NuGet che richiedono una versione esatta.

E infine, raccomandazioni di non indicano qualcosa che non si dovrebbe quasi mai fare:

❌ NON pubblicare versioni con nome sicuro e non con nome sicuro della libreria. Ad esempio, Contoso.Api e Contoso.Api.StrongNamed.

Avanti