在VS2017中使用StyleCop

What is StyleCop

StyleCop本质上说是通过源代码分析器对代码规范进行检查的工具，它不仅仅检查代码格式，而是编码规范，包括命名和注释等。StyleCop可以帮助你更容易地进行这项活动。StyleCop现在包含了 200 个左右的最佳实践规则，这些规则与 Visual Studio 中默认的代码格式化规则是一致的。它会根据预定义的C#代码格式的最佳实践，对我们的源代码进行检查，并给出不符合编码风格的错误提示。可以帮助团队成员强制执行一组代码样式和一致性规则。

StyleCop in VS2017

VS2017中通过使用StyleCop.Analyzers包进行代码规范检查。
StyleCop: https://github.com/StyleCop/StyleCop
StyleCop.Analyzers：https://github.com/DotNetAnalyzers/StyleCopAnalyzers

1. 安装

通过NuGet Package Manager安装:
在项目->管理NuGet程序包(N) 或者 在项目上右键，点击管理NuGet程序包，显示NuGet包管理界面，如下图所示：

选择安装包

将StyleCop.Analyzers包安装至项目成功后，在项目中 Properties->分析器 中会添加StyleCop.Analyzers项。

2.定义规则

在解决方案视图中，选择项目XXX，“引用”-->"分析器"，右键“打开活动规则集”，选择Style.Analyzers，根据需要设置检查项，如下图所示：

设置规则

可自定义规则，保存之后，项目中会生成XXX.ruleset和packages.config两个文件。
完成1，2两个步骤，就可以实现StyleCope的功能。

检查结果

3.共享规则

完成上述两步，就能实现使用StyleCop对代码进行检测。但在实际项目过程中，每个项目都需要单独设置规则显得很繁琐。各个项目设置的规则也有可能出现不统一的情况。下面进行简单配置可以使得多个项目使用同一个规则文件。

• 使用步骤1，2将一个项目的规则设置完成。将生产的XXX.ruleset文件保存至任意路径。
• 为其他项目添加StyleCop.Analyzers包。

• 右键项目，选择属性，进入代码分析页，通过浏览选择保存的规则文件：

  
  选择通用规则

完成上述后，引用同一规则文件的项目，将通用设置的规则。任意项目修改后，其他项目也同样生效。

结语

编码规范应该是每一个Coder应该具有的基本素养，如何能编写出简洁、规范的代码显得尤为重要。是代码质量的一个重要指标，好的代码一定是遵从规范的，往往能达到事半功倍的效果。不应该有任何理由来忽视代码的规范性。