技术开发 频道

新版.NET开发必备十大工具之GhostDoc

ITPUB 专稿

参看前一篇文章:

   新版.Net开发必备十大工具综述

   新.Net开发必备十大工具详解之Snippet Compiler

摘要

   在新版.Net开发必备十大工具一文中,笔者整理总结了.NET平台下开发必备的十大工具,在本篇文章中,我将详细介绍自动生成文档注释工具GhostDoc。

工具介绍
 
   GhostDoc是Visual Studio的一个免费插件,可以帮助开发者生成比较完整规范的XML格式代码注释,如果你的代码遵循微软类库开发人员设计规范 ,由它自动产生的注释就已经完全可以很好地表达开发者创建的方法或者属性的意图,无需手工再进行修改。有了这些标准的XML注释,我们可以使用微软的文档工具Sandcastle生成专业级别的帮助文档。

使用场景 

   自动为我们编写的代码产生标准的XML注释。

安装配置
 

   在运行GhostDoc2.1.3 for Visual Studio 2008之后,安装步骤基本上按照默认的方式进行,如下图所示:



安装进度:



   在安装过程中,注意需要关闭Visual Studio 2008,否则将不能正确安装。在安装完成后,第一次启动Visual Studio将会提示你进行GhostDoc配置,如设置热键等,这些都可以默认,不用做特殊设置。一会儿我们将会进行GhostDoc的配置。

0
相关文章