What is styleCop
styleCop本質上說是透過原始碼分析器對程式碼規範進行檢查的工具，它不僅僅檢查程式碼格式，而是編碼規範，包括命名和註釋等。 styleCop可以幫助你更容易地進行這項活動。 styleCop現在包含了 200 個左右的最佳實踐規則，這些規則與 Visual Studio 中預設的程式碼格式化規則是一致的。它會根據預定義的C#程式碼格式的最佳實踐，對我們的原始碼進行檢查，並給出不符合編碼風格的錯誤提示。可以幫助團隊成員強制執行一組程式碼樣式和一致性規則。
styleCop in VS2017
VS2017中透過使用 styleCop.Analyzers包進行程式碼規範檢查。
styleCop: https://github.com/ styleCop/ styleCop
styleCop.Analyzers：https://github.com/DotNetAnalyzers/ styleCopAnalyzers
1. 安裝
透過NuGet Package Manager安裝:
在計畫->管理NuGet程式包(N) 或者 在計畫上右鍵，點選管理NuGet程式包，顯示NuGet包管理界面，如下圖所示：
選擇安裝包
將 styleCop.Analyzers包安裝至計畫成功後，在計畫中 Properties->分析器 中會添加 styleCop.Analyzers項。
2.定義規則
在解決方案檢視中，選擇計畫XXX，「參照」-->"分析器"，右鍵「開啟活動規則集」，選擇 style.Analyzers，根據需要設定檢查項，如下圖所示：
設定規則
可自訂規則，保存之後，計畫中會生成XXX.ruleset和packages.config兩個檔。
完成1，2兩個步驟，就可以實作 styleCope的功能。
檢查結果
3.共享規則
完成上述兩步，就能實作使用 styleCop對程式碼進行檢測。但在實際計畫過程中，每個計畫都需要單獨設定規則顯得很繁瑣。各個計畫設定的規則也有可能出現不統一的情況。下面進行簡單配置可以使得多個計畫使用同一個規則檔。
使用步驟1，2將一個計畫的規則設定完成。將生產的XXX.ruleset檔保存至任意路徑。
為其他計畫添加 styleCop.Analyzers包。
右鍵計畫，選擇內容，進入代分碼析頁，透過瀏覽選擇保存的規則檔：
選擇通用規則
完成上述後，參照同一規則檔的計畫，將通用設定的規則。任意計畫修改後，其他計畫也同樣生效。
結語
編碼規範應該是每一個Coder應該具有的基本素養，如何能編寫出簡潔、規範的程式碼顯得尤為重要。是程式碼品質的一個重要指標，好的程式碼一定是遵從規範的，往往能達到事半功倍的效果。不應該有任何理由來忽視程式碼的規範性。
作者：LightRunner
連結：https://www.jianshu.com/p/dab842095449
來源：簡書
著作權歸作者所有。商業轉載請聯系作者獲得授權，非商業轉載請註明出處。
