介紹
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,可以打開如下對話框:
根據自己項目的需要,選擇合適的規則。