VS2017使用StyleCop.Analyzers进行代码规范检查

简介

StyleCop.Analyzers是一个Nuget，用于.NET编译器平台的StyleCop分析器，该存储库包含使用.NET编译器平台的StyleCop规则的实现。 在可能的情况下，还会提供代码修复以简化纠正违规的过程。

使用分析器的首选方法是将nuget包StyleCop.Analyzers添加到要执行StyleCop规则的项目中。

单个规则的严重性可以使用Visual Studio 2015或更新版本中的规则集文件进行配置。 Settings.StyleCop不受支持，但可以使用stylecop.json文件来自定义某些规则的行为。

GitHub上有详细介绍:

StyleCop: https://github.com/StyleCop/StyleCop

StyleCop.Analyzers：https://github.com/DotNetAnalyzers/StyleCopAnalyzers

安装

可以使用NuGet命令行或Visual Studio 2017中的NuGet Package Manager来安装StyleCopAnalyzers。

命令行安装

Install-Package StyleCop.Analyzers

NuGet Package Manager安装

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

由于我已经安装，所以直接就显示出来，如果没有安装，可以选择“浏览”，在搜索框中输入StyleCop.Analyzers选择安装即可，如下图所示：

使用

自定义规则

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

可自定义规则，保存之后，项目中会生成XXX.ruleset和packages.config两个文件。

效果

如下图所示：

带有绿色波浪线的就是可能存在编码不规范的地方，可根据自身或公司编码规范进行调整。

结束语

编码规范是一个Coder应该具有的基本素养，如何能编写出简洁、规范的代码显得尤为重要，借用Python之禅与各位共勉：

优美胜于丑陋（以编写优美的代码为目标）

明了胜于晦涩（优美的代码应当是明了的，命名规范，风格相似）

简洁胜于复杂（优美的代码应当是简洁的，不要有复杂的内部实现）

复杂胜于凌乱（如果复杂不可避免，那代码间也不能有难懂的关系，要保持接口简洁）

扁平胜于嵌套（优美的代码应当是扁平的，不能有太多的嵌套）

间隔胜于紧凑（优美的代码有适当的间隔，不要奢望一行代码解决问题）

可读性很重要（优美的代码是可读的）

即便假借特例的实用性之名，也不可违背这些规则（这些规则至高无上）

不要包容所有错误，除非你确定需要这样做（精准地捕获异常，不写 except:pass 风格的代码）

当存在多种可能，不要尝试去猜测 而是尽量找一种，最好是唯一一种明显的解决方案（如果不确定，就用穷举法）

虽然这并不容易，因为你不是 Python 之父（这里的 Dutch 是指 Guido ）

做也许好过不做，但不假思索就动手还不如不做（动手之前要细思量）

如果你无法向人描述你的方案，那肯定不是一个好方案；反之亦然（方案测评标准）

命名空间是一种绝妙的理念，我们应当多加利用（倡导与号召）