Question

在整个或C＃源代码中，我们有很多评论错过了这样的实际内容：

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

或者这个：

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

或者这个：

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

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

Answer 1

尝试XML Comment Checker：

XML Comment Checker是一个应用程序这将检查XML文档用于遗漏的.Net程序集。它提供更全面的检查而不是C＃编译器本身，而且是非常适合您希望检查的时间在编译之前的评论真实的文档，例如使用微软Sandcastle。

从功能列表中：

检查空白部分。（可选） XML Comment Checker会发出警告必需的部分或元素存在，但空洞。这不是默认启用

Visual Studio中的用法：

XML Comment Checker可以设置为 Visual Studio中的post-build事件自动检查装配。的的 XML Comment发出的警告检查器已经格式化，以便 Visual Studio将识别它们和在错误列表中显示它们。一个示例post-build命令行： “PathToCommentChecker \ CommentChecker.exe” “$（TargetPath）” - nologo -warnemptysections

Answer 2

ReSharper是Visual Studio的这个（许多其他的）缺点的答案。对于任何不使用它的人，我只有可惜。 ;）

Answer 3

FxCop和自定义规则？

Answer 4

您可以使用XSLT文件并针对XSLT文件调试xml，如果xml格式不正确，则会抛出错误，显示xml未正确形成的确切行号。这个简单的XSLT文件可以工作 -

<?xml version="1.0" encoding="utf-8"?>
<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
    xmlns:msxsl="urn:schemas-microsoft-com:xslt" exclude-result-prefixes="msxsl"
>
    <xsl:output method="xml" indent="yes"/>

    <xsl:template match="@* | node()">
        <xsl:copy>
            <xsl:apply-templates select="@* | node()"/>
        </xsl:copy>
    </xsl:template>
</xsl:stylesheet>

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

4 个答案: