(转)StyleCop


微软的StyleCop作为一款代码分析插件,集成到Visual Studio 2008和Visual Studio 2010之中,可以帮助开发人员迅速地理清编程规范问题。对确保软件质量,确保软件开发效率而言,意义非凡。与同样出自微软的另一款代码分析工具fxcop通过分析程序集来检查各类编程规范错误不同的是,StyleCop是针对C#源代码的分析工具。有点类似java的checkstyle。

 

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

 

安装StyleCop以后,在解决方案视图中右键点击项目,在弹出菜单选择“Run StyleCop”即可运行代码检查,结果默认将被输出至“Warnings”清单。也可以修改通过配置项,将其输出至“Errors”清单。开发人员可以方便地定位并修改编程规范问题。

 

StyleCop可以与MSBuild进行集成。这样当开发人员点击“生成”项目时,将自动运行StyleCop检查,无须选择“Run StyleCop”菜单。而且,通过使用SVNStyleCop插件,可以方便地在SVN库上进行代码check in检查,对不符合代码规范的check in动作进行回滚。

 

以下步骤介绍如何集成StyleCop至MSBuild,即让开发人员直接点击“生成”项目就可以进行代码检查:

1,安装MSBuild集成文件。默认情况下,安装StyleCop不会选中安装“MSBuild files”,因此在安装时,进行到如下步骤时,确保选中“MSBuild files”进行安装。


 
2,在项目文件中增加Import配置节。要使得某个项目可以集成到MSBuild,需要使用诸如NotePad之类的编辑器打开项目文件(.csproj),添加如下红色字体部分,并保存项目文件:
 <Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">

   ...Contents Removed...

 

  <Import Project="$(MSBuildBinPath)\Microsoft.CSharp.targets" />

  <Import Project="$(ProgramFiles)\MSBuild\Microsoft\StyleCop\v4.3\Microsoft.StyleCop.targets" /> 

 

   ...Contents Removed...

 

</Project>

重新加载项目之后,该项目即可集成到MSBuild当中了。

 

StyleCop还可以很方便地集成到团队开发和构建环境,如CI中。


  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值