簡介
StyleCop.Analyzers是一個Nuget,用于.NET編譯器平台的StyleCop分析器,該存儲庫包含使用.NET編譯器平台的StyleCop規則的實作。 在可能的情況下,還會提供代碼修複以簡化糾正違規的過程。
使用分析器的首選方法是将nuget包StyleCop.Analyzers添加到要執行StyleCop規則的項目中。
單個規則的嚴重性可以使用Visual Studio 2015或更新版本中的規則集檔案進行配置。 Settings.StyleCop不受支援,但可以使用stylecop.json檔案來自定義某些規則的行為。
GitHub上有詳細介紹:
StyleCop: https://github.com/StyleCop/StyleCop
StyleCop.Analyzers:https://github.com/DotNetAnalyzers/StyleCopAnalyzers
安裝
可以使用NuGet指令行或Visual Studio 2017中的NuGet Package Manager來安裝StyleCopAnalyzers。
指令行安裝
Install-Package StyleCop.Analyzers
NuGet Package Manager安裝
在項目->管理NuGet程式包(N) 或者 在項目上右鍵,點選管理NuGet程式包,顯示NuGet包管理界面,如下圖所示:

由于我已經安裝,是以直接就顯示出來,如果沒有安裝,可以選擇“浏覽”,在搜尋框中輸入StyleCop.Analyzers選擇安裝即可,如下圖所示:
使用
自定義規則
在解決方案視圖中,選擇項目XXX,“引用”-->"分析器",右鍵“打開活動規則集”,選擇Style.Analyzers,如下圖所示:
可自定義規則,儲存之後,項目中會生成XXX.ruleset和packages.config兩個檔案。
效果
如下圖所示:
帶有綠色波浪線的就是可能存在編碼不規範的地方,可根據自身或公司編碼規範進行調整。
結束語
編碼規範是一個Coder應該具有的基本素養,如何能編寫出簡潔、規範的代碼顯得尤為重要,借用Python之禅與各位共勉:
優美勝于醜陋(以編寫優美的代碼為目标)
明了勝于晦澀(優美的代碼應當是明了的,命名規範,風格相似)
簡潔勝于複雜(優美的代碼應當是簡潔的,不要有複雜的内部實作)
複雜勝于淩亂(如果複雜不可避免,那代碼間也不能有難懂的關系,要保持接口簡潔)
扁平勝于嵌套(優美的代碼應當是扁平的,不能有太多的嵌套)
間隔勝于緊湊(優美的代碼有适當的間隔,不要奢望一行代碼解決問題)
可讀性很重要(優美的代碼是可讀的)
即便假借特例的實用性之名,也不可違背這些規則(這些規則至高無上)
不要包容所有錯誤,除非你确定需要這樣做(精準地捕獲異常,不寫 except:pass 風格的代碼)
當存在多種可能,不要嘗試去猜測 而是盡量找一種,最好是唯一一種明顯的解決方案(如果不确定,就用窮舉法)
雖然這并不容易,因為你不是 Python 之父(這裡的 Dutch 是指 Guido )
做也許好過不做,但不假思索就動手還不如不做(動手之前要細思量)
如果你無法向人描述你的方案,那肯定不是一個好方案;反之亦然(方案測評标準)
命名空間是一種絕妙的理念,我們應當多加利用(倡導與号召)