如何在VS執行Code Analysis

在VS裡面也有兩種執行的方式：

1. 手動執行
   
2. 建制的時候自動執行

手動執行

在Analyze功能裡面可以先對每一個project用的規則做設定，然後就可以手動執行。

設定使用規則

1. 在Tool bar選擇：Analyze -> Configure Code Anaysis - > For Solution
   
2. 可以設定每一個專案所要使用的規則集
   
3. 如果想自訂規則集也可以

執行靜態程式碼分析

在Analyze -> Run Code Anaysis -> For Solution

建制的時候自動執行

能夠手動執行當然好，但是不能夠自動執行嗎？

在Visual Studio其實有提供設定讓Code Analysis在兼職的時候自動執行。

對要設定建制自動執行的專案點 右鍵 -> Properties -> Code Analysis 然後把 Enable Code Analysis on Build打鉤即可

在這邊也可以設定要用那個規則集和更詳細調整哪一個規則要開啟：

在build的時候在執行靜態程式碼分析

既然能夠手動執行和在建制的時候自動執行，那為什麼不在那個時候執行就好？

原因很簡單，時間問題。

當專案越來越大，每跑一次靜態程式碼分析的時間會需要越來越長。在考慮到還要執行單元測試，整個加在一起會拖累整個開發速度。

所以為了整個開發的速度能夠快，但是又不犧牲程式碼的品質，這種靜態程式碼分析通常都是在build server執行 - 因為那個時候要執行多久都不會打斷開發時間。

要在build的時候執行靜態程式碼分析，需要設定三個參數：

1. RunCodeAnalysis=true - 表示要執行靜態程式碼分析
   
2. CodeAnalysisRuleSet=AllRules.ruleset - 要用那個規則集執行 - 出入內建的規則集 如果有客製規則集，可以把規則集的路徑放入參數
   
3. CodeAnalysisTreatWarningsAsErrors=true - 這個主要目的是把靜態程式碼分析出來有問題的部分當做Error而不是Warning。

最後，default.ps1調整如下：

task Compile -depends Clean, Init -description "編譯程式碼" `
    -requiredVariables solutionFile, buildConfiguration, buildTarget, buildTempDirectory `
{ 
 Write-Host "開始建制檔案：$solutionFile"

 $buildParam = "Configuration=$buildConfiguration" +
     ";Platform=$buildTarget" + 
     ";OutDir=$buildTempDirectory"
 
 $buildParam = $buildParam + ";GenerateProjectSpecificOutputFolder=true"
 $buildParam = $buildParam + ";RunCodeAnalysis=true;CodeAnalysisRuleSet=AllRules.ruleset;CodeAnalysisTreatWarningsAsErrors=true"

 exec {msbuild $solutionFile "/p:$buildParam"}
}

結語

這篇快速介紹了靜態程式碼分析，並且如何在VS和build script裡面使用。

實際上這個可以更詳細的看每一個規則，和介紹一下一般來說那些要打開，不過這個畢竟不是這個系列的重點。

希望透過這篇，就能夠立竿見影開始使用靜態程式碼分析來提升程式碼品質。

在下一篇將會介紹另外一個角度的靜態程式碼分析 - 用來統一團隊開發風格的工具StyleCop。