iT邦幫忙

DAY 9
1

使用Jenkins打造.Net CI Server系列 第 9

CI Server 09 - 統一程式碼撰寫風格 (StyleCop)

  • 分享至 

  • xImage
  •  

我們目前學會了如何透過Jenkins來建置系統和執行單元測試,
這可以幫助我們讓版本控制系統上的程式碼都是穩定可用的。
接下來,我將向大家介紹如何使用靜態程式碼分析來提升軟體品質,
增加程式碼的可維護性,也減少程式碼的複雜度和潛在的風險。

在今天的文章中,我將向大家介紹StyleCop,它是一套程式碼規範檢查工具,
可以掃描程式碼,檢查是否符合設定的規則,
例如命名規則、函數是否有加註解等等。
※安裝StyleCop

  1. 程式載點: http://stylecop.codeplex.com/
  2. 執行安裝程式

※開始使用StyleCop

  1. 安裝完成之後,打開我們的專案,
    在專案上點選滑鼠右鍵,可以看到出現Run StyleCop的選項
  2. 點選Run StyleCop,可以看到輸出視窗顯示執行結果
  3. 點選錯誤清單,我們可以看到不符合規範的項目,
    提示某些函數沒有註解,或是using沒按照順序排列等
  4. 可以在警告項目上點選滑鼠右鍵,顯示錯誤說明
  5. 會顯示出詳細的錯誤資訊,以及正確的範例

※調整StyleCop設定
雖然StyleCop提供了豐富的程式碼規範,
但並不一定是完全符合我們團隊的程式碼風格,
這時候就可以根據自己團隊的習慣進行設定的微調,
以符合自己團隊的風格。

  1. 在專案上按滑鼠右鍵,選擇StyleCop Setting
  2. 假設我們想要取消SA1200這條規則的檢查,
    因為我們不習慣將using放在namespace之中,
    我們可以在右上角搜尋打SA1200,再把這條規則取消並儲存設定
  3. StyleCop預設是不允許使用匈牙利命名法的,
    但有時候系統中會有一些慣用的縮寫或專有名詞可能會被誤判,
    我們可以把它加入到例外清單之中,
    點選Hungarian,輸入要新增的名字,選擇add並儲存
  4. 當我們修正完所有不符規範的項目後,重新執行一次,
    確認我們的程式碼是符合規範的

※總結
所有團隊的成員如果都能夠在CheckIn之前都通過StyleCop檢查,
或是CodeReview時要求所有新的程式碼都要通過StyleCop,
就可以讓程式碼的撰寫風格能夠統一,
日後若不同人員在維護程式碼時,可以更輕易的讀懂程式碼,
大大的增加可維護性,減少適應不同風格的時間成本,
在明天我將會教大家如何將StyleCop整合進Jenkins的建置之中,
並將StyleCop的報表顯示在CI Server上,讓管理起來更方便,
關於今天的內容若有任何問題,歡迎大家提出來一起討論!


上一篇
CI Server 08 - 設定每日建置
下一篇
CI Server 10 - 讓Jenkins顯示StyleCop報表
系列文
使用Jenkins打造.Net CI Server30
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言