C# 代碼規範和質量檢查工具 StyleCop.Analyzers

簡介

原來一直用 ReSharper 來進行代碼質量檢查，不過畢竟是收費的，因此想找個免費的能夠推廣給公司的同事也一塊兒用。搜索了一下，找到了StyleCop，可是我在 VS 2015裏安裝 StyleCop 或者經過 Nuget 包安裝 StyleCop.MSBuild，雖然編譯之後能把 warning 顯示在 Error List 中，可是沒法經過 項目---右鍵 配置 StyleCop 的規則，最終在找到了一個 StyleCopAnalyzers 也算是 StyleCop 的新版本吧。

主要使用了 Visual Studio 2015's Roslyn 分析工具，帶來了如下的好處：

• 能夠支持 C# 6
• 使用 Roslyn 解析器，減小了自定義解析器的性能消耗
• 當你寫代碼的時候解析器就會運行，當你編譯的時候也會運行（不須要再設置 msbuild 任務或者安裝任何 vs 插件）

 

安裝

安裝的話比較簡單，在項目裏管理 NuGet 包，輸入 StyleCop.Analyzers 而後安裝就能夠了

安裝完成就直接能夠看到效果了，StyleCop.Analyzers 會像 ReSharper 那樣在你寫代碼的時候就提示錯誤，而不用編譯之後才發現錯誤了。

不過編譯之後仍是會把全部的錯誤提示顯示出來

 

配置自定義規則

在上面的圖片裏，能夠看到個人項目一共有32個 StyleCop 警告，下面咱們就把 SA1652 警告去除。

找到引用裏得 Analyzer，右鍵點擊 Open Active Rule Set，就能夠打開規則表

而後找到 StyleCop.Analyzers 的規則 SA1652，取消勾選，而後保存。

最終會在項目裏生成一個 .ruleset 後綴的文件就是咱們的自定義規則。

編譯之後查看效果，就會發現前面提示的 SA1652 的警告已經沒有了。