Die Suche nach fehlenden XML-Kommentare Inhalt mit Visual Studio
-
06-07-2019 - |
Frage
Während oder C # Quellcode wir viele Kommentare haben, die den eigentlichen Inhalt, wie wie dies verpassen:
/// <summary>
/// </summary>
oder folgt aus:
/// <summary>
///
/// </summary>
oder folgt aus:
/// <param Name="flag"></param>
Leider Visual Studio erzeugt keine Warnungen für diese Art von fehlenden Kommentaren. Aber für uns wäre es schön, wenn wir einfach klick auf ein Element in einer Liste (z. B. die Warings Liste) in Visual Studio und dann auf die fehlerhafte Stelle im Quellcode genommen werden, sie zu korrigieren. Auch wäre es schön, die Liste der fehlenden XML-Kommentar Inhalt auf jedem Build der XML-Dateien zu sehen. Sie haben keine Ahnung, wie dies zu erreichen?
Lösung 2
ReSharper ist die Antwort auf diese (wie viele andere) Manko von Visual Studio. Ich habe nichts als Mitleid für alle, die es nicht verwenden. ;)
Andere Tipps
Versuchen Sie XML Kommentar Checker :
XML Kommentar Checker ist eine Anwendung, dass überprüft die XML-Dokumentation für eine NET-Assembly für Auslassungen. Es bietet eine umfassende Überprüfung als der C # Compiler selbst, und ist ideal, wenn Sie wünschen, dass Ihre überprüfen Kommentare, bevor sie in der Zusammenstellung reale Dokumentation, beispiel mit Microsoft Sandcastle.
Von der Feature-Liste:
Überprüfen Sie für leere Abschnitte. Optional XML-Kommentar Checker falls vorhanden warnen der erforderlichen Teile oder Elemente vorhanden ist, aber leer. Das ist nicht standardmäßig aktiviert
Verwendung von Visual Studio:
XML Kommentar Checker kann als die festgelegt werden Post-Build-Ereignis in Visual Studio überprüft automatisch eine Baugruppe. Die Warnungen von XML-Kommentar emittiert Checker wurde so formatiert, dass Visual Studio erkennt sie und zeigt sie in der Fehlerliste. Ein Beispiel Post-Build-Befehlszeile ein: "PathToCommentChecker \ CommentChecker.exe" "$ (TargetPath)" -nologo -warnemptysections
FxCop und eine benutzerdefinierte Regel?
Sie können eine XSLT-Datei und Debuggen der xml gegen die XSLT-Datei verwenden, und dann wird es Fehler aus, wenn die XML nicht gut Sie die genaue Zeilennummer gebildet wird, zeigt, gegen die das XML nicht gut ausgebildet ist. Diese einfache XSLT-Datei funktioniert -
<?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>