前言
曾幾何時,你是否在看別人代碼的時候總是在抱怨代碼沒有注釋,命名不規范,代碼風格不統一,代碼可讀性差?是否有一個適合團隊開發規范的檢查工具?
答案就是大名鼎鼎的StyleCop代碼檢查插件,有了這個統一標准的代碼工具,今后就不用抱怨代碼風格不合理了,當然前提是你能推動(或者說“要求”)團隊成員嚴格履行代碼約束,否則一切僅是美好的憧憬。OK,廢話不多說了,現在請跟我一起來體驗吧。
一、StyleCop安裝
下載並默認安裝:
安裝過程中,要關閉Visual Studio XXX,安裝過程可能要2分鍾。
二、啟動VS並運行StyleCop
- 啟動VS,打開一現有項目。
- 選擇“工具” --- “Run StyleCop”。
- 查看“錯誤列表”(Error List)中的警告項,如圖:
Wow, 好多的警告信息,看來作者的代碼“太不規范了” :(
4. 按照提示消除警告信息,重復步驟2。如果能做到0警告你就完美了~~~
二、自定義StyleCop
默認設置的代碼警告項非常多,而我們實際開發中又想過渡的嚴格而影響團隊開發效率,那該如何是好呢?好在,StyleCop為我們提供了定制功能,只需簡單的設置幾步就可以完美的切合進我們現有的系統。
下面列舉幾個例子:
錯誤:SA1650:The element documentation for the element contains one or more spelling mistakes or unrecognized words. 簡而言之,是注釋中含有拼寫錯誤。
我們習慣上懶惰的情況加是直接復制Class的名字(或者屬性名)作為注釋,這樣字符串是連在一塊的,SqlDataSource並不符合注釋規范,默認StyleCop是不識別的,所以提示了SA1650錯誤,當然還有另一個情況是我們開發時候注釋只中文的情況下支持的也不是很好,所以,我們暫且可以屏蔽掉這一提示。
這里有兩種方式:
- 局部忽略錯誤:在錯誤提示上增加標簽以忽略此項。其實就是在我們的SqlDataSource類上增加注釋,這是官方文檔中提供的方式。
- 全局忽略錯誤:右鍵項目---選擇StyleCop Setting---Rules---Documentation Rules---Element Documentation---取消SA1650---點擊OK
這樣,我們就可以自定義每個項目的檢查項,是否應用某些規則,以平衡我們自己的項目,這里只是拋磚引玉,以SA1650為例,更多項目請讀者連接官方的Html文檔查看,下一節會介紹如何快速查看Html文檔。
二、快速查看官方文檔
當我們遇到一對英文提示錯誤時,根本不理解其所雲,也不知道如何更改才能符合“規則”,這里有一個快速的方法連接到某一錯誤的官方詳細文檔,當然,有道詞典也是必不可少的:)
步驟:單擊警告項---右鍵---點擊顯示錯誤信息
三、更多高級功能
這里列出官方給出的用戶引用准則:
User Guide:
- A Brief History of C# Style
- Why Should We Use StyleCop?
- History of StyleCop
- Managing StyleCop Project Settings
- Sharing StyleCop Settings Across Projects
- Setting Up StyleCop MSBuild Integration
- Running StyleCop in VS2005 or VS Express
- Using File Lists
- Using StyleCop on Legacy Projects
- Rule Suppressions
- Property Headers
- List of StyleCop R# fixes
- Registry Settings for Auto-update checks
- Enabling Tracing to Investigate Performance Issues
- Downloading older version of StyleCop
- Running analysis on a mapped network drive