StyleCop(C#代碼規範分析工具)—1.介紹,下載及配置

介紹

　　StyleCop 是項目層級，開源免費，靜態分析C#代碼規範的工具，具有功能強大，簡單易用，配置靈活等特點。StyleCop中內建的代碼規範是根據.Net Framework 架構的設計原則來制定的！當然，你也可以建立自己的規則！StyleCop包括兩個版本，一個是GUI版，一個是命令列。最新的StyleCop已經自動整合到VS2010當中，方便應用。

規則包括以下類別:

• 文檔(Documentation)
• 布局(Layout)
• 可維護性(Maintainability)
• 命名(Naming)
• 順序(Ordering)
• 可讀性(Readability)
• 間隔(Spacing)  

 

下載及配置

　　StyleCop首頁是:http://stylecop.codeplex.com/,可以在DownLoad下載最新版，當前最新版是4.7.17.0。下載的是個MSI檔案直接雙擊運行，安裝成功後，重新開啟VS2010，在項目中右擊項目名稱，發現多了兩個選擇項(Run StyleCop和StyleCop Settings)。:

 

Run StyleCop

　　會根據選擇的規則,分析項目中的代碼。如果你想分析某個檔案或者某個檔案夾下所有檔案，可以直接在該檔案或者檔案夾上右擊，在選擇Run StyleCop即可。
分析完畢後會在 錯誤清單 中以警告的形式顯示所有資訊。

 

StyleCop Settings

　　可以設定需要的規則。選擇StyleCop Settings,可以開啟如下對話方塊：

根據自己項目的需要，選擇合適的規則。