介绍:
StyleCop analyzes是一个C#源码分析工具,用于检测代码样式、质量和可维护性、设计及其他问题。
项目地址
https://github.com/DotNetAnalyzers/StyleCopAnalyzers (Roslyn)
其它类似的工具还有
Roslynator, XUnit Analyzers, and Sonar Analyzer
在Visual Studio中,其实自带了一个代码样式分析工具,可以在工具->选项->文本编辑器->C#->代码样式开启
我这里使用的是Visual Studio 2015,这个功能在17/19版本中得到了增强,具体使用可参考
https://docs.microsoft.com/zh-cn/visualstudio/ide/code-styles-and-code-cleanup?view=vs-2019
VS2015
VS2017
StyleCop analyzes使用
1、使用nuget下载Stylecop analyzes包
2、当引入StyleCop.Analyzers包以后,会强制Visual Studio使用StyleCop定义的代码规范规则来检测你的代码是否符合这些规范 。
这个时候我们再打开代码文件,就会发现多了很多绿色的波浪线,这些就是提醒你需要修改的地方。
完整的规则定义可访问以下链接
https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/DOCUMENTATION.md
配置代码分析规则
StyleCop Analyzers可以通过两种方式来进行配置: 规则集文件和stylecop.json文件.
1、规则集文件是VS的一部分,这里不做介绍,可通过以下链接来获取详细的使用方式
https://docs.microsoft.com/zh-cn/visualstudio/code-quality/using-rule-sets-to-group-code-analysis-rules?view=vs-2019
2、stylecop.json文件