引领代码整洁新时代:NsDepCop - C# 命名空间依赖检查器
NsDepCop是一个强大的静态代码分析工具,专为C#项目设计,用于确保命名空间的依赖关系符合预定义的规则。这个工具不仅能在构建过程中运行并报告问题,而且还能防止未计划或未被注意到的依赖引入到你的系统中。
简单上手
- 将NsDepCop NuGet包添加到你的C#项目中:
- 创建一个名为
config.nsdepcop
的文件,并编写依赖规则。 - 之后,任何违反规则的依赖关系将在代码编辑器中标记出来,并在构建时像编译错误/警告一样显示。
想要更直观的了解如何操作?查看由plainionist提供的教程视频。
要获得config.nsdepcop
文件编辑时的验证和IntelliSense支持,请参考这里,将XML架构添加到Visual Studio的缓存中。
详细的帮助文档可参见此处。
v2.0 新特性
版本2.0的重大改进是实现了从MSBuild任务+Visual Studio扩展到标准Roslyn分析器的转变:
- **支持.NET Core / .NET 5+**项目。
- 不再需要NsDepCop Visual Studio扩展。
- NuGet包现在可以在构建时间和Visual Studio编辑器内部工作。
- 添加了NuGet包的项目在Solution Explorer中会显示:项目 / 依赖项 / 分析器 / NsDepCop.Analyzer
- 通过Visual Studio轻巧菜单或.editorconfig文件可以配置问题严重性(参考微软官方文档)。
- 要求Visual Studio 2019/2022 (16.10.0 或更高版本)。
- 已停止对VS 2015/2017的支持,如需继续使用,请转至NsDepCop v1.11.0。
- 不再需要外部服务主机。
- 再也不会出现“无法与NsDepCop服务通信”的错误。
请注意,暂时不支持AutoLowerMaxIssueCount功能,如果使用该功能,暂时不要升级到v2.0。
版本信息
详细的版本历史记录可在更改日志中查看。
反馈与建议
- 使用问题跟踪器记录bug和功能请求。
- 或者在Twitter上找到我:
更多资源
致谢
- 感谢Roslyn为我们提供了最佳的解析器API。
- 感谢ReSharper提供的免费许可证以及这款卓越的工具。
- 感谢DotNet.Glob提供的globbing库。
许可证
本项目遵循GPL-2.0许可。
让我们一起迎接更整洁、更有序的代码时代,使用NsDepCop让您的C#项目保持清晰且规范的依赖关系管理。立即开始使用,感受高效开发的魅力吧!
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考