代码审查工具StyleCop之一:介绍和使用

一、StyleCop介绍

      先简单介绍下FxCop(起初只是微软内部使用的工具),一个分析托管程序集,检测代码的总体正确性的工具,告诉用户哪些地方不符合设计规范。他使用的评估规则已经发展了多年,凝聚了顶尖.Net框架开发人员的知识和技术。但是FxCop是基于托管代码分析的,即编译后的程序集。而StyleCop同样是用来检查代码是否符合设计规范的,它是基于原代码验证的,仅支持C#语言,就是在开发期间进行代码验证的工具,相信在日常开发中,会帮助到大家,在使用工具的同时,逐渐改善和提高大家的编码规范和意识,另外,相关内容推荐大家读下《.Net设计规范-.Net约定、贯用法与模式》这本书。

二、StyleCop使用

1、下载最新版本4.7:http://stylecop.codeplex.com/    

    4.7 is compatible with:

  • JetBrains R# 5.1.3 ( 5.1.3000.12)
  • JetBrains R# 6.0 (6.0.2202.688)
  • JetBrains R# 6.1 (6.1.37.86)
  • JetBrains R# 6.1.1 (6.1.1000.82)
  • JetBrains R# 7.0.1 (7.0.1098.2760)
  • JetBrains R# 7.1.3 (7.1.3000.2254)
  • JetBrains R# 8.2 (8.2.0.2160)
  • Visual Studio 2008
  • Visual Studio 2010
  • Visual Studio 2012
  • Visual Studio 2013

2、安装。(按照提示安装,此处省略)

3、使用。现在打开Visual Studio,我以Visual Studio2008为例,见下图:

 

在项目菜单上会出现StyleCop相关菜单。点击“Run StyleCop”,出现一大堆警告,StyleCop已经把不符合规范的相关警告全部列出,并且已经定位到行和列,双击任一条项目即可定位到问题点。如下图所示:

也可以基于单个文件进行检查,只要在当前代码页右键点击“Run StyleCop”即可,见下图:

其中检验的规则可在项目名称的右键菜单“StyleCop Settings”中设定,见下图,使用中发现对中文支持的不是很好。其中一些不适用的校验规则可以不勾选即可。

 

posted @ 2015-12-09 16:39  帅姐  阅读(1792)  评论(0编辑  收藏  举报