两个VS的文档工具

做个笔记：

GhostDoc 会自动生成 XML 注释

当 XML 注释协助将源代码注释自动转换为 RTF 帮助文档时，仍须写入注释文本，这是一项令很多开发人员感到精疲力尽的工作。为什么不使用自动化来加速这些注释的创建呢？这正是 GhostDoc 1.9.5 试图实现的目标。

GhostDoc 是一个免费的 Visual Studio 加载项，由 Roland Weigelt 创建，用来协助编写 XML 注释。一旦安装了 GhostDoc，只要使用它指一指、点一点，就能轻松地自动生成 XML 注释。例如，若要将 XML 注释添加到某个方法中，只需在该方法中右键单击，然后从上下文菜单中选择“Document This”选项。然后，GhostDoc 就会根据该方法的类型、参数、名称和其他上下文信息为其自动生成 XML 注释文本。

如果您正在 .NET Framework 中为使用某个类型的属性或方法生成文档，则 GhostDoc 将会使用 Microsoft 已为该类型编写的文档。如果您使用 Pascal 大小写格式或 Camel 大小写格式，GhostDoc 可将该名称拆分成几个单词，并分析这些单独的单词，以生成文档。所有的文档逻辑都按照 GhostDoc 的生成规则来处理。既可以对这些内置规则进行自定义，也可以添加新的规则。还可以导出这些规则，以便在其他计算机上使用。

除最简单的成员外，您不能完全依赖 GhostDoc 为您编写 XML 注释。GhostDoc 自动生成的注释只是建议，还需开发人员进行审核。无论如何，GhostDoc 是一个值得一试的注释编写插件，它可以节省大量时间。

网址：http://www.roland-weigelt.de/ghostdoc

 

 

NDoc

根据XML注释自动生成帮助文件的开源软件，就不用多介绍了。

网址：http://ndoc.sourceforge.net/

因为 NDoc不支持.Net Framework 1.0 以上的版本，所以似乎用处不大了，这里有

支持2.0的版本，http://community.rainbowportal.net/blogs/jonathans_rainbow_blog/archive/2006/03/21/1685.aspx

支持VS 2005的版本：http://sourceforge.net/project/showfiles.php?group_id=163095

不过都是beta版，功能不全。

 

参考文章：

Open Source Tools and Visual Studio 2008 / .NET 3.5

Generating MSDN-style Documentation with Sandcastle, NAnt and CruiseControl.NET