一、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這個工具能夠帶給我的不僅僅是合作開發時代碼規范整潔一致，對于初級程序員來說，形成自己的編碼風格要比前者的收獲更大。

總結

以上是生活随笔為你收集整理的【颗粒归仓】（四）代码走查工具---StyleCop的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。