使用Visual Studio查找缺少的XML注释内容

Question

在整个或C#源代码中,我们有很多评论错过了实际内容,如下所示:

/// <summary>
/// </summary>

或这个:

/// <summary>
///
/// </summary>

或这个:

/// <param Name="flag"></param>

不幸的是,Visual Studio不会为此类缺失注释生成警告.但是对于我们来说,如果我们可以在视觉工作室内点击列表中的项目(例如,警告列表)然后被带到源代码中的错误位置来纠正它将会很好.此外,在每次构建xml文件时都会看到缺少xml注释内容的列表.你对如何实现这个有任何想法吗？

Answer 1

试试XML Comment Checker:

XML Comment Checker是一个应用程序,它将检查.Net程序集的XML文档是否有遗漏.它提供了比C#编译器本身更全面的检查,非常适合在您将注释编译成真实文档(例如使用Microsoft Sandcastle)之前检查您的注释.

从功能列表中:

检查空白部分.(可选)XML注释检查器将警告是否存在任何所需的部分或元素,但为空.默认情况下不启用此功能

Visual Studio中的用法:

可以将XML Comment Checker设置为Visual Studio中的构建后事件,以自动检查程序集.XML Comment Checker发出的警告已经过格式化,因此Visual Studio将识别它们并在错误列表中显示它们.一个示例生成后命令行:"PathToCommentChecker\CommentChecker.exe""$(TargetPath)"-nologo -warnemptysections

Answer 2

ReSharper是Visual Studio的这个(许多其他的)缺点的答案.对于任何不使用它的人,我只有可惜.;)