项目笔记---事半功倍之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