【颗粒归仓】（四）代码走查工具---StyleCop

一、StyleCop是什么？

      StyleCop是代码规范检查工具（Code Review 工具），它不仅仅检查代码格式，而是编码规范，包括命名和注释等。开源是这个工具最大的特点！

 

二、应用场景

      StyleCop是微软公司开发的一款应用，可以在vs中作为插件进行代码走查，也可以集成到MSBuild中进行代码走查，主要针对C#代码进行走查。

      StyleCop可以检查代码中的各类静态编程规范错误，从代码注释，代码布局，可维护性，命名规范，可读性等各方面对代码规范性进行检查。重要的是，其规则可以自定义，可以屏蔽掉不适用于特定项目的规则，甚至可以自定义开发适用于各自项目的规则。

 

三、安装使用

      官网：http://stylecop.codeplex.com/ ，下载最新版本V4.7.54支持在VS2012、vs2013中进行安装使用。

      (1)初始安装过程默认选择”Visual Studio integration”，即作为VS的插件来使用，如图：

                   

      (2)安装成功之后，打开VS，在“解决方案管理器”中右击需要走查的项目，如图：单击"Run StyleCop"

                     

      (3)在“错误列表”窗口中将会对该”类or项目”中不符合预设代码风格的地方以“警告”的形式标出，如图：

  

      (4)针对错误列表中给出的信息进行规范化改进，当然对于规范的限制，可以手动进行筛选以及设定，如图：

            

       自定义设置编码规则，将专门用一篇博客来介绍。

 

四、检查规则

         • 布局（Layout ofelements, statements, expressions, and query clauses ）

         • 括号位置（Placement ofcurly brackets, parenthesis, square brackets, etc ）

         • 空格（Spacing aroundkeywords and operator symbols ）

         • 行距（Line spacing ）

         • 参数位置（Placement ofmethod parameters within method declarations or method calls ）

         • 元素标准排列（Standardordering of elements within a class ）

         • 注释格式（Formatting ofdocumentation within element headers and file headers ）

         • 命名（Naming ofelements, fields and variables ）

         • 内置类型的使用（Use of thebuilt-in types ）

         • 访问修饰符的使用（Use ofaccess modifiers ）

         • 文件内容（Allowed contentsof files ）

         • Debugging文本（Debuggingtext）

 

      StyleCop从以上12个方面对C#代码进行走查，它会根据预定义的200多个C#代码格式的最佳实践（编码规范），对我们的源代码进行检查，并给出不符合编码风格的错误提示。

 

      StyleCop这个工具能够带给我的不仅仅是合作开发时代码规范整洁一致，对于初级程序员来说，形成自己的编码风格要比前者的收获更大。