Diretrizes da biblioteca

Essa orientação fornece recomendações para os desenvolvedores criarem bibliotecas .NET de alta qualidade. Esta documentação se concentra no que e por que ao criar uma biblioteca .NET, não em como.

Aspectos das bibliotecas .NET de alta qualidade:

• Inclusive – Boas bibliotecas do .NET se esforçam para dar suporte a várias plataformas, linguagens de programação e aplicativos.
• Estável – boas bibliotecas do .NET coexistem no ecossistema do .NET, em execução em aplicativos criados com muitas bibliotecas.
• Projetadas para evoluir – as bibliotecas do .NET devem melhorar e evoluir ao longo do tempo, ao mesmo tempo em que dão suporte aos usuários existentes.
• Depuráveis – as bibliotecas .NET devem usar as ferramentas mais recentes para criar uma ótima experiência de depuração para os usuários.
• As bibliotecas .NET confiáveis têm a confiança dos desenvolvedores por publicarem no NuGet usando as práticas recomendadas de segurança.

Introdução

Tipos de recomendações

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

Procure quase sempre seguir a recomendação Fazer. Por exemplo:

✔️ Distribua sua biblioteca usando um pacote NuGet.

Por outro lado, considere que as recomendações geralmente devem ser seguidas, mas há exceções legítimas à regra e você não deve se sentir mal por não seguir as diretrizes:

✔️ CONSIDERAR o uso do SemVer 2.0.0 para criar a versão do seu pacote NuGet.

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

❌ EVITE referências de pacote NuGet que exigem uma versão exata.

Por fim, Não recomendações indicam algo que você quase nunca deve fazer:

❌ NÃO publique versões de nome forte e sem nome forte da biblioteca. Por exemplo, Contoso.Api e Contoso.Api.StrongNamed.

Próximo