本指南为开发人员提供了创建高质量 .NET 库的建议。 本文档重点介绍生成 .NET 库时的是什么和原因,而不是如何做。
高质量 .NET 库的各个方面:
- 包容性 - 良好的 .NET 库努力支持许多平台、编程语言和应用程序。
- 稳定 - 良好的 .NET 库共存于 .NET 生态系统中,在使用许多库生成的应用程序中运行。
- 设计为不断发展 - .NET 库应随着时间推移而改进和演变,同时支持现有用户。
- Debuggable - .NET 库应使用最新的工具为用户创建出色的调试体验。
- 受信任 - .NET 库可通过使用安全最佳做法发布到 NuGet 来信任开发人员。
建议类型
每篇文章都提供了四种类型的建议: Do、 Consider、 Avoid 和 Do not。 建议类型表示了应遵循的程度。
应始终遵循“请执行”建议。 例如:
✔️ 请使用 NuGet 包分发您的库。
在另一方面,“请考虑”建议是在一般情况下要遵循的建议,但存在该规则的合法例外,此时不遵循指南也不妨:
✔️ 请考虑使用 SemVer 2.0.0 对 NuGet 包进行版本控制。
避免 建议提及通常不是好主意的事情,但有时打破规则是有意义的:
❌ 请避免使用需要确切版本的 NuGet 包引用。
最后,“请勿”建议是指在大多数情况下不得执行的操作:
❌ 请勿发布库的强名称版本和非强名称版本。 例如,Contoso.Api
和 Contoso.Api.StrongNamed
。