天天看點

代碼審查工具StyleCop之一:介紹和使用

一、StyleCop介紹

      先簡單介紹下FxCop(起初隻是微軟内部使用的工具),一個分析托管程式集,檢測代碼的總體正确性的工具,告訴使用者哪些地方不符合設計規範。他使用的評估規則已經發展了多年,凝聚了頂尖.Net架構開發人員的知識和技術。但是FxCop是基于托管代碼分析的,即編譯後的程式集。而StyleCop同樣是用來檢查代碼是否符合設計規範的,它是基于原代碼驗證的,僅支援C#語言,就是在開發期間進行代碼驗證的工具,相信在日常開發中,會幫助到大家,在使用工具的同時,逐漸改善和提高大家的編碼規範和意識,另外,相關内容推薦大家讀下《.Net設計規範-.Net約定、貫用法與模式》這本書。

二、StyleCop使用

1、下載下傳最新版本4.7:http://stylecop.codeplex.com/    

    4.7 is compatible with:

  • JetBrains R# 5.1.3 ( 5.1.3000.12)
  • JetBrains R# 6.0 (6.0.2202.688)
  • JetBrains R# 6.1 (6.1.37.86)
  • JetBrains R# 6.1.1 (6.1.1000.82)
  • JetBrains R# 7.0.1 (7.0.1098.2760)
  • JetBrains R# 7.1.3 (7.1.3000.2254)
  • JetBrains R# 8.2 (8.2.0.2160)
  • Visual Studio 2008
  • Visual Studio 2010
  • Visual Studio 2012
  • Visual Studio 2013

2、安裝。(按照提示安裝,此處省略)

3、使用。現在打開Visual Studio,我以Visual Studio2008為例,見下圖:

代碼審查工具StyleCop之一:介紹和使用

在項目菜單上會出現StyleCop相關菜單。點選“Run StyleCop”,出現一大堆警告,StyleCop已經把不符合規範的相關警告全部列出,并且已經定位到行和列,輕按兩下任一條項目即可定位到問題點。如下圖所示:

代碼審查工具StyleCop之一:介紹和使用

也可以基于單個檔案進行檢查,隻要在目前代碼頁右鍵點選“Run StyleCop”即可,見下圖:

代碼審查工具StyleCop之一:介紹和使用

其中檢驗的規則可在項目名稱的右鍵菜單“StyleCop Settings”中設定,見下圖,使用中發現對中文支援的不是很好。其中一些不适用的校驗規則可以不勾選即可。

代碼審查工具StyleCop之一:介紹和使用

轉載于:https://www.cnblogs.com/shuaijie/articles/5033309.html

c#