Finding fehlende XML-Kommentare Inhalt mit Visual Studio

Question

Während oder C# Quellcode wir haben eine Menge Kommentare, die den eigentlichen Inhalt, wie wie dies verpassen:

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

oder dies:

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

oder diese:

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

Leider generiert Visual Studio keine Warnungen für diese Art von fehlenden Kommentaren. Aber für uns wäre es schön, wenn wir einfach einen Eintrag in einer Liste (zB die Warings-Liste) im Visual Studio anklicken und dann im Quellcode an den fehlerhaften Ort bringen könnten, um ihn zu korrigieren. Es wäre auch schön, die Liste der fehlenden XML-Kommentarinhalte bei jedem Build der XML-Dateien zu sehen. Haben Sie eine Idee, wie Sie das erreichen können?

Answer 1

ReSharper ist die Antwort auf diese (wie viele andere) Manko von Visual Studio -nologo . Ich habe nichts als Mitleid mit jemandem, der es nicht benutzt. ;)

Answer 2

FxCop und eine benutzerdefinierte Regel?

Answer 3

Versuchen XML Comment Checker:

XML Kommentar Checker ist eine Anwendung , die die XML-Dokumentation für eine .NET-Assembly für Auslassungen überprüfen. Es bietet ein umfassenderes als der C# Compiler Überprüfung selbst und ist ideal, wenn Sie wünschen, dass Ihre Kommentare zu überprüfen, bevor sie in reale Dokumentation, beispiels mit Microsoft Sandcastle kompilieren.

Von der Feature-Liste:

prüfen für leere Abschnitte. Optional, XML Comment Checker warnt, wenn der erforderlichen Abschnitte oder Elemente vorhanden sind, aber leer. Dies ist nicht standardmäßig aktiviert

Verwendung von Visual Studio:

XML Kommentar Checker kann als Postbuildereignis in Visual Studio zu Prüfung eine Baugruppe automatisch eingestellt werden. Die Warnungen emittiert von XML-Kommentar Checker formatiert haben, so dass Visual Studio wird sie erkennen und sie in der Fehlerliste angezeigt werden soll. Ein Beispiel Post-Build-Befehlszeile ein: "PathToCommentChecker \ CommentChecker.exe" "$ (TargetPath)" -warnemptysections

Answer 4

Sie können eine XSLT-Datei verwenden und das XML gegen die XSLT-Datei debuggen, und dann wird ein Fehler ausgegeben, wenn der XML-Code nicht korrekt ist und Ihnen die genaue Zeilennummer anzeigt, für die der XML-Code nicht korrekt ist. Diese einfache XSLT-Datei Works-

<?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>