Partager via

Guide des bibliothèques

  • Article

Cette aide fournit des recommandations à l’attention des développeurs qui créent des bibliothèques .NET de qualité. Cette documentation se concentre sur le quoi et le pourquoi de la création d’une bibliothèque .NET, mais pas sur le comment.

Aspects des bibliothèques .NET de qualité :

  • Inclusives - Les bonnes bibliothèques .NET s’efforcent de prendre en charge plusieurs plateformes, langages de programmation et applications.
  • Stables - Les bonnes bibliothèques .NET coexistent dans l’écosystème .NET en s’exécutant dans les applications créées avec de nombreuses bibliothèques.
  • Conçues pour évoluer - Les bibliothèques .NET doivent s’améliorer et évoluer au fil du temps tout en prenant en charge les utilisateurs existants.
  • Débogables - Les bibliothèques .NET doivent utiliser les derniers outils afin de créer une excellente expérience de débogage pour les utilisateurs.
  • Approuvées - Les bibliothèques .NET ont la confiance des développeurs en publiant sur NuGet à l’aide des bonnes pratiques de sécurité.

Bien démarrer

Types de suggestions

Chaque article présente quatre types de suggestions : À faire, Envisager, Éviter et À ne pas faire. Le type de suggestion indique si celle-ci doit être suivie ou pas.

Vous devez presque toujours suivre une suggestion À faire. Par exemple :

✔️ À FAIRE : Distribuer votre bibliothèque à l’aide d’un package NuGet.

En revanche, les recommandations Envisager doivent généralement être appliquées, mais il existe des exceptions à la règle qui sont fondées, c’est pourquoi vous ne devez pas vous inquiéter si vous ne les suivez pas :

✔️ ENVISAGER d’utiliser SemVer 2.0.0 pour versionner votre package NuGet.

Les suggestions Éviter indiquent quelque chose qui n’est généralement pas une bonne idée, mais enfreindre les règles peut parfois avoir du sens :

❌ ÉVITEZ les références de package NuGet qui exigent une version précise.

Et enfin, les suggestions À ne pas faire désignent quelque chose que vous ne devez presque jamais faire :

❌ À NE PAS FAIRE : publier les versions avec et sans nom fort de votre bibliothèque. Par exemple : Contoso.Api et Contoso.Api.StrongNamed.

Next