背景
项目团队刚刚组件,每个人的代码编写习惯都不一样,希望用一款代码规范的检查插件来规范团队成员编写代码的习惯,在网上找了一遍之后,感觉StyleCop.Analyzers比较适用。
集成方法
1.NuGet搜索StyleCop.Analyzers进行安装到指定的一个项目。
![在这里插入图片描述](https://img-blog.csdnimg.cn/99d0400352ca4b95999c09ea2046fcb3.png)
2.安装完之后,发现只是这个项目具备了代码的检查功能,不符合规范的代码都会出现下划线警告。但我们不可能每个项目都去安装配置一下。所以需要将这个代码规范配置到整个解决方案。开发安装的项目的.csproj文件,复制这边引入StyleCop.Analyzers组件的路径,然后将这个路径也复制到其他项目的.csproj文件即可。这样整个解决方案下面的所有项目都引用同一个.StyleCop.Analyzers DLL,使用同一个配置的规则。
![在这里插入图片描述](https://img-blog.csdnimg.cn/fd9ed61fbe83482397dba4933e2eba87.png)
3.自动生成代码规则配置文件。我们完成上面的操作之后,项目就会自动生成一个Solution Items 文件夹,里面有会有editcofig文件。这里面是所有的规则的配置,如果觉得有些规则不符合自己项目编写代码的要求,可以禁用这些规则,如果觉得必须遵循一些规则,则可以把规则的严重性设置为错误,这边如果没有按照这个规范写,代码就会报错。
![在这里插入图片描述](https://img-blog.csdnimg.cn/39778a04abbb48609b59a34c7df15f7a.png)
4.规则列表,可以自己根据需要去修改(点击editconfig文件)
![在这里插入图片描述](https://img-blog.csdnimg.cn/07fe1d4030a5473c95ade98ed983c00a.png)