code-prettify

2014年7月25日 星期五

C# 程式碼風格分析 StyleCop 與 Visual Studio Express 整合


首先到 http://stylecop.codeplex.com/ 網站下載並安裝 StyleCop,
安裝過程就下一步按到底就完成了。
如果你使用的 Visual Studio 不是 Express 版本 (Professional, Premium, Ultimate...etc),
這時候在 Visual Studio > 方案總管 裡面對著專案按下右鍵,就會出現 Run StyleCop,
詳細的說明請參考這篇文章  [Tool]程式碼風格分析-StyleCop

因為 Visual Studio Express 不支援任何 UI 方面的擴充功能 (Extensions),
所以就算安裝完之後,是不會有任何變化的。
這時候可以手動在專案檔 (.csproj) 上設定,讓每一次建置 (Build) 的時候都執行一次 StyleCop 檢查。

在專案檔裡面加上這一行:
<Import Project="$(ProgramFiles)\MSBuild\StyleCop\v4.7\StyleCop.targets" />

這麼一來,這個專案每次建置的時候,就會進行 StyleCop 檢查,錯誤訊息也會出現在 Visual Studio 的錯誤清單讓你檢視。當然,「檢示錯誤訊息」功能是不存在的,只能用錯誤代號自行查詢了。

延伸問題:
一、每個專案都要手動加上設定。
這點可以用靠修改範本讓新建立的專案都先加上設定,舊的就只能一個一個改。

二、如果這個專案在另一個沒有安裝 StyleCop 的電腦上建置,那專案就會建置失敗。
雖然可以透過 NuGet 安裝 StyleCop 來解決這個問題,但是考慮到 StyleCop Rule 的一致性,還是建議統一安裝 StyleCop。

Reference
StyleCop
Intergrating StyleCop with Visual Studio Express
[Tool]程式碼風格分析-StyleCop

沒有留言:

張貼留言