項目筆記---事半功倍之GhostDoc(二)

前言

前一篇文章《項目筆記---事半功倍之StyleCop(一)》提到如何約束代碼，規范代碼風格，這一節，我們將了解如何快速生成符合規則的代碼注釋---GhostDoc

 

一、安裝GhostDoc

http://submain.com/download/ghostdoc/

輸入一郵箱即可下載，然后點擊GhostDoc v4.9.14358.exe進行安裝，這里我沒有安裝Pro版。

默認安裝時可選擇應用在VS2008、VS2010、VS2013版本中，前提是你已經安裝了這些版本的VS。

二、使用GhostDoc

啟動VS，新建一個類，然后創建一個方法如圖所示：

           

然后將鼠標放在方法體的內部，右鍵---選擇Document This（或者Ctrl+Shift+D快捷鍵），將自動依據方法名和入參名生成注釋：

 

屬性的生成也是如此，先定義屬性，然后Ctrl+Shift+D生成注釋：

 

GhostDoc相對於VS自帶的注釋生成器最大的優勢在於其能依據語義自動生成注釋內容，而“///”則只能生成空白注釋，所以，這也就是在要求為我們在創建類的時候要依據規范編寫類名及參數變量名。

三、自定義GhostDoc

請參考文章：

首推官方文檔：

http://community.submain.com/blogs/tutorials/archive/2013/03/28/how-to-access-ghostdoc-pro-features.aspx?utm_campaign=ghostdoc&utm_medium=email&utm_source=lifecycle

 

目前，更多高級功能僅支持GhostDoc Pro版本, 版本差異：

 

GhostDoc文檔十分全面並且很容易上手，強烈推薦官方文檔。

引用

http://www.cnblogs.com/zpq521/archive/2011/02/21/1959389.html

http://www.cnblogs.com/anderslly/archive/2006/12/14/ghostdocintroduction.html