代码审查工具 StyleCop 的探索

最近我们Advent Data Service (ADS) 在项目上需要按照代码规范进行代码的编写工作，以方便将来代码的阅读与维护。

但是人工检查起来容易遗漏或者格式不统一， ReSharper又是收费的，而且费用不菲。

于是美国的同事推荐了我们一款开源工具 StyleCop，我想无论是对公司项目还是个人的项目，都是有所帮助的，所以想写下来与大家分享。

StyleCop官网地址：http://stylecop.codeplex.com/, 这里有大家需要的msi安装文件，源代码和说明文档等资源。

• 现在最新的版本是 4.7.50，这是一个Alpah版本，支持Visual Studio 2015 （暂时不支持C# 6.0的语法）

 

• StyleCop有两种安装方式
  • 直接在官网下载msi安装程序，双击安装
  • 在Visual Studio中，Tools --> Extensions and Updates… --> Extensions and Updates… --> Online --> 搜索stylecop，找到Visual StyleCop并安装

 

• 安装完成之后，打开Visual Studio并打开一个项目，右键选择一个Project，会发现多了三个选项

 

• Run StyleCop与Run StyleCop(Rescan All)会审查已有代码，并且在Error List中显示代码中不符合规范的Warning

第一个图是执行了Run StyleCop的Error List, 第二个图是执行了Build的Error List

   

• StyleCop Setting：在实际项目中，可能现有的规则并不适用于我们的项目，需要我们自己通过StyleCop Setting进行配置

 

以上都是StyleCop的基本功能，希望能对大家有所帮助，也欢迎大家进行交流讨论。

Tips: 在Visual Studio中，规范化C#项目代码格式的快捷键是Ctrl + k，再按一下Ctrl + d。在编写完代码后，按下这个组合，代码就会规规矩矩的排列了☺