C#代碼檢查工具：stylecop

http://minmin86121.blog.163.com/blog/static/49681157201182044847408/

微軟的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中。

StyleCop已經開源：http://stylecop.codeplex.com/

SVNStyleCop請參見：http://svnstylecop.codeplex.com/