如何使用StyleCop 進行代碼評審

今天就跟大家聊聊有關如何使用StyleCop 進行代碼評審，可能很多人都不太了解，為了讓大家更加了解，小編給大家總結了以下內容，希望大家根據(jù)這篇文章可以有所收獲。

使用StyleCop對原代碼進行審查，看編寫的代碼是否遵循設計規(guī)范、.Net約定和一些貫用法等。保證代碼的一致性，可讀性等等。

在此之前，先簡單介紹下FxCop（起初只是微軟內部使用的工具）,一個分析托管程序集，檢測代碼的總體正確性的工具，告訴用戶哪些地方不符合設計規(guī)范。他使用的評估規(guī)則已經發(fā)展了多年，凝聚了頂尖.Net框架開發(fā)人員的知識和技術。但是FxCop是基于托管代碼分析的，即編譯后的程序集。今天我們介紹的StyleCop同樣是用來檢查代碼是否符合設計規(guī)范的，它是基于原代碼驗證的，僅支持C#語言，就是在開發(fā)期間進行代碼驗證的工具，相信在日常開發(fā)中，會幫助到大家，在使用工具的同時，逐漸改善和提高大家的編碼規(guī)范和意識，另外，相關內容推薦大家讀下《.Net設計規(guī)范-.Net約定、貫用法與模式》這本書。

首先，還是先下載最新版的StyleCop.，下載地址：http://stylecop.codeplex.com/，更簡單的方法是在VisualStudio中，Tools --> Extensions and Updates… --> Extensions and Updates…--> Online --> 搜索stylecop，找到Visual StyleCop并安裝。

安裝完成之后，打開Visual Studio并打開一個項目，右鍵選擇一個Project，會發(fā)現(xiàn)多了三個選項。

Run StyleCop與Run StyleCop(RescanAll)會審查已有代碼，并且在Error List中顯示代碼中不符合規(guī)范的Warning，下圖是執(zhí)行了Run StyleCop的Error List

StyleCop Setting：在實際項目中，可能現(xiàn)有的規(guī)則并不適用于我們的項目，需要我們自己通過StyleCop Setting進行配置

StyleCop檢查的規(guī)則包括：

• 布局（Layout ofelements, statements, expressions, and query clauses ）

• 括號位置（Placement ofcurly brackets, parenthesis, square brackets, etc ）

• 空格（Spacing aroundkeywords and operator symbols ）

• 行距（Line spacing ）

• 參數(shù)位置（Placement ofmethod parameters within method declarations or method calls ）

• 元素標準排列（Standardordering of elements within a class ）

• 注釋格式（Formatting ofdocumentation within element headers and file headers ）

• 命名（Naming ofelements, fields and variables ）

• 內置類型的使用（Use of thebuilt-in types ）

• 訪問修飾符的使用（Use of accessmodifiers ）

• 文件內容（Allowed contentsof files ）

• Debugging文本（Debugging text）

看完上述內容，你們對如何使用StyleCop 進行代碼評審有進一步的了解嗎？如果還想了解更多知識或者相關內容，請關注億速云行業(yè)資訊頻道，感謝大家的支持。