.Net开发必备十大工具(二)

GhostDoc

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

 

public bool Add(string item) 
{ 
//...... 
} 

public void AppendHtmlText(IHtmlProvider htmlProvider) 
{ 
//...... 
} 

   使用GhostDoc生成的注释如下：

/// <summary> 
/// Adds the specified item. 
/// </summary> 
/// <param name="item">The item.</param> 
/// <returns></returns> 
public bool Add(string item) 
{ 
//...... 
} 

/// <summary> 
/// Appends the HTML text. 
/// </summary> 
/// <param name="htmlProvider">The HTML provider.</param> 
public void AppendHtmlText(IHtmlProvider htmlProvider) 
{ 
//...... 
} 

   官方主页：http://www.roland-weigelt.de/ghostdoc/

Sandcastle

   Sandcastle是微软发布的一个帮助文档生成工具，它通过反射程序集中的源代码和添加代码到中的XML注释来创建专业级别的帮助文档。Sandcastle于2006年推出，它的面世也使得曾经列入.NET开发必备十大工具之一的文档生成工具NDoc的作者Kevin Downs在2006年7月宣告不再投入NDoc Open Source Project的开发。生成的文档效果如下图所示：