介紹:
StyleCop analyzes是一個C#源碼分析工具,用於檢測代碼樣式、質量和可維護性、設計及其他問題。
項目地址
https://github.com/DotNetAnalyzers/StyleCopAnalyzers (Roslyn)
其它類似的工具還有
Roslynator, XUnit Analyzers, and Sonar Analyzer
在Visual Studio中,其實自帶了一個代碼樣式分析工具,可以在工具->選項->文本編輯器->C#->代碼樣式開啟
我這里使用的是Visual Studio 2015,這個功能在17/19版本中得到了增強,具體使用可參考
https://docs.microsoft.com/zh-cn/visualstudio/ide/code-styles-and-code-cleanup?view=vs-2019
VS2015
VS2017
StyleCop analyzes使用
1、使用nuget下載Stylecop analyzes包
2、當引入StyleCop.Analyzers包以后,會強制Visual Studio使用StyleCop定義的代碼規范規則來檢測你的代碼是否符合這些規范 。
這個時候我們再打開代碼文件,就會發現多了很多綠色的波浪線,這些就是提醒你需要修改的地方。
完整的規則定義可訪問以下鏈接
https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/DOCUMENTATION.md
配置代碼分析規則
StyleCop Analyzers可以通過兩種方式來進行配置: 規則集文件和stylecop.json文件.
1、規則集文件是VS的一部分,這里不做介紹,可通過以下鏈接來獲取詳細的使用方式
https://docs.microsoft.com/zh-cn/visualstudio/code-quality/using-rule-sets-to-group-code-analysis-rules?view=vs-2019
2、stylecop.json文件