项目笔记---事半功倍之StyleCop(一)

前言

曾几何时，你是否在看别人代码的时候总是在抱怨代码没有注释，命名不规范，代码风格不统一，代码可读性差？是否有一个适合团队开发规范的检查工具？

         答案就是大名鼎鼎的StyleCop代码检查插件，有了这个统一标准的代码工具，今后就不用抱怨代码风格不合理了，当然前提是你能推动（或者说“要求”）团队成员严格履行代码约束，否则一切仅是美好的憧憬。OK，废话不多说了，现在请跟我一起来体验吧。

 

一、StyleCop安装

下载并默认安装：

http://stylecop.codeplex.com/

安装过程中，要关闭Visual Studio XXX，安装过程可能要2分钟。

 

二、启动VS并运行StyleCop

1. 启动VS，打开一现有项目。
2. 选择“工具” --- “Run StyleCop”。
3. 查看“错误列表”（Error List）中的警告项，如图：

 　　

　　Wow, 好多的警告信息，看来作者的代码“太不规范了” ：（

　　4. 按照提示消除警告信息，重复步骤2。如果能做到0警告你就完美了~~~

二、自定义StyleCop

默认设置的代码警告项非常多，而我们实际开发中又想过渡的严格而影响团队开发效率，那该如何是好呢？好在，StyleCop为我们提供了定制功能，只需简单的设置几步就可以完美的切合进我们现有的系统。

下面列举几个例子：

错误：SA1650：The element documentation for the element contains one or more spelling mistakes or unrecognized words. 简而言之，是注释中含有拼写错误。

 

我们习惯上懒惰的情况加是直接复制Class的名字（或者属性名）作为注释，这样字符串是连在一块的，SqlDataSource并不符合注释规范，默认StyleCop是不识别的，所以提示了SA1650错误，当然还有另一个情况是我们开发时候注释只中文的情况下支持的也不是很好，所以，我们暂且可以屏蔽掉这一提示。

这里有两种方式：

1. 局部忽略错误：在错误提示上增加标签以忽略此项。其实就是在我们的SqlDataSource类上增加注释，这是官方文档中提供的方式。

 

1. 全局忽略错误：右键项目---选择StyleCop Setting---Rules---Documentation Rules---Element Documentation---取消SA1650---点击OK

 

 

这样，我们就可以自定义每个项目的检查项，是否应用某些规则，以平衡我们自己的项目，这里只是抛砖引玉，以SA1650为例，更多项目请读者连接官方的Html文档查看，下一节会介绍如何快速查看Html文档。

二、快速查看官方文档

当我们遇到一对英文提示错误时，根本不理解其所云，也不知道如何更改才能符合“规则”，这里有一个快速的方法连接到某一错误的官方详细文档，当然，有道词典也是必不可少的：）

步骤：单击警告项---右键---点击显示错误信息

 

 

 

三、更多高级功能

这里列出官方给出的用户引用准则：

User Guide:

• A Brief History of C# Style
• Why Should We Use StyleCop?
• History of StyleCop
• Managing StyleCop Project Settings
• Sharing StyleCop Settings Across Projects
• Setting Up StyleCop MSBuild Integration
• Running StyleCop in VS2005 or VS Express
• Using File Lists
• Using StyleCop on Legacy Projects
• Rule Suppressions
• Property Headers
• List of StyleCop R# fixes
• Registry Settings for Auto-update checks
• Enabling Tracing to Investigate Performance Issues
• Downloading older version of StyleCop
• Running analysis on a mapped network drive

 

官方文档链接： http://stylecop.codeplex.com/documentation