寻找失踪的XML注释

纵观或C＃源代码中我们有很多的未命中的实际内容，像这样的评论：寻找失踪的XML注释

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

或本：

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

或这样的：

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

不幸的是Visual Studio不会为这类缺少的注释产生警告。但是对于我们来说，如果我们可以在Visual Studio中敲击列表中的项目（例如，warings列表），然后将其带到源代码中的错误位置来纠正它，那将会很好。另外，每次构建xml文件时都会看到缺少xml注释内容的列表。你有什么想法如何实现这一目标？

来源

2008-11-05 bitbonk

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

来源

2010-05-21 12:45:35 bitbonk

FxCop和自定义规则？

来源

2008-11-05 08:46:27 bob

尝试XML Comment Checker：

XML注释检查器是一个应用程序将检查XML文档用于.NET程序集的遗漏。它提供了一个更全面的检查比C＃编译器本身，而且是理想的，当你想汇编成真正的文档，使用e.g微软沙堡前检查您的意见。

从功能列表：

检查空的部分。（可选） XML注释检查器将警告是否存在所需截面或元素的任何，但是为空。这不是默认启用从Visual Studio

用法：

XML注释检查器可装配自动设置为在Visual Studio中生成后事件检查。 由XML Comment 发出的警告已被格式化，因此 Visual Studio会将它们识别为和将它们显示在错误列表中。一个例如生成后命令行： “PathToCommentChecker \ CommentChecker.exe” “$（TARGETPATH）” -nologo -warnemptysections

来源

2008-11-05 08:48:06 xsl

Allthough的消息出现在Warings列表这个简单的XSLT文件在Visual Studio中，不可能点击一个华林跳转到源代码的位置。 – bitbonk 2008-11-05 09:41:58

您可以使用XSLT文件和调试对XSLT文件的XML，然后如果XML的格式不正确显示你针对的XML格式不正确形成确切的行号，它将引发错误。工程─

<?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-28 01:38:02

寻找失踪的XML注释

回答

相关问题