Partilhar via

Orientação da biblioteca

  • Artigo

Esta orientação fornece recomendações para que os desenvolvedores criem bibliotecas .NET de alta qualidade. Esta documentação centra-se no quê e no porquê ao construir uma biblioteca .NET, não no como.

Aspetos das bibliotecas .NET de alta qualidade:

  • Inclusive - As bibliotecas Good .NET esforçam-se por suportar muitas plataformas, linguagens de programação e aplicações.
  • Estável - As boas bibliotecas .NET coexistem no ecossistema .NET, funcionando em aplicações construídas com muitas bibliotecas.
  • Projetado para evoluir - as bibliotecas .NET devem melhorar e evoluir ao longo do tempo, ao mesmo tempo que suportam os utilizadores existentes.
  • Bibliotecas depurativas - .NET devem usar as ferramentas mais recentes para criar uma grande experiência de depuragem para os utilizadores.
  • Confiáveis - As bibliotecas .NET têm a confiança dos desenvolvedores publicando para o NuGet usando as melhores práticas de segurança.

Introdução

Tipos de recomendações

Cada artigo apresenta quatro tipos de recomendações: Fazer, Considerar, Evitar e Não. O tipo de recomendação indica o quanto deve ser seguido.

Deve seguir quase sempre uma recomendação do Do . Por exemplo:

✔️ DO distribuir a sua biblioteca através de um pacote NuGet.

Por outro lado, considere as recomendações geralmente seguidas, mas existem exceções legítimas à regra e não deve sentir-se mal por não seguir as orientações:

✔️ CONSIDERE usar o SemVer 2.0.0 para ver o seu pacote NuGet.

Evite recomendações que mencionem coisas que geralmente não são uma boa ideia, mas quebrar a regra às vezes faz sentido:

❌ EVITE referências de pacotes NuGet que exijam uma versão exata.

E, finalmente, não as recomendações indicam algo que quase nunca deve fazer:

❌ NÃO publique versões de nome forte e não-forte da sua biblioteca. Por exemplo, Contoso.Api e Contoso.Api.StrongNamed.

Seguinte