Microsoft Source Analysis for C#

   Microsoft Source Analysis for C#是一款 C#（不支持 VB.NET）代码规范检查工具，前身是
微软内部代码规范检查和代码格式强制工具 StyleCop，目的是帮助项目团队执行一系列常用
的源代码格式规范，它会根据预定义的 C#代码格式的最佳实践进行检查，与 FxCop 不同的
是它直接对源代码进行检查，且并不提供灵活的规则设置，强制开发者使用相同的习惯进行
C#代码的编写。如下图所示：

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>