7

在整个 C# 源代码中，我们有很多注释错过了实际内容，例如：

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

或这个：

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

或这个：

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

不幸的是，Visual Studio 不会为这种类型的缺失注释生成警告。但是对我们来说，如果我们可以在 Visual Studio 中单击列表中的一个项目（例如，warings 列表），然后将其带到源代码中的错误位置来纠正它，那就太好了。此外，在每次构建 xml 文件时看到缺少的 xml 注释内容列表也会很高兴。您对如何实现这一目标有任何想法吗？

4

4 回答 4

7

试试XML 评论检查器：

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

从功能列表中：

检查空白部分。可选地，如果任何必需的部分或元素存在但为空，XML 注释检查器将发出警告。默认情况下未启用此功能

Visual Studio 的用法：

XML Comment Checker 可以设置为 Visual Studio 中的构建后事件以自动检查程序集。XML Comment Checker 发出的警告已被格式化，以便 Visual Studio 能够识别它们并将它们显示在错误列表中。构建后命令行示例： "PathToCommentChecker\CommentChecker.exe" "$(TargetPath)" -nologo -warnemptysections

于 2008-11-05T08:48:06.100 回答
5

ReSharper 是 Visual Studio 的这个（以及许多其他）缺点的答案。对于不使用它的人，我只有同情。;)

于 2010-05-21T12:45:35.803 回答
1

FxCop和自定义规则？

于 2008-11-05T08:46:27.647 回答
0

您可以使用 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>
于 2016-01-28T01:38:02.020 回答