Trouver le contenu des commentaires XML manquant avec Visual Studio

Question

Tout au long ou C# sourcecode nous avons beaucoup de commentaires qui ratent le contenu réel tel comme celui-ci:

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

ou ceci:

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

ou ceci:

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

Malheureusement, Visual Studio ne génère pas d'avertissement pour ce type de commentaire manquant. Mais pour nous, ce serait bien si nous pouvions juste cliquer sur un élément dans une liste (par exemple la liste des warings) à l'intérieur du studio visuel et ensuite être pris à l'endroit défectueux dans le code source pour le corriger. Il serait également intéressant de voir la liste des commentaires manquants sur chaque version des fichiers xml. Avez-vous une idée sur la façon d'y parvenir?

Answer 1

ReSharper est la réponse à cette (comme beaucoup d'autres) défaut de Visual Studio . Je n'ai que de la pitié pour ceux qui ne l'utilisent pas. ;)

Answer 2

FxCop et une règle personnalisée?

Answer 3

Essayez XML Comment Checker:

XML Commentaire Checker est une application qui vérifie la documentation XML pour un assemblage .Net pour les omissions. Il propose une approche plus globale vérifier que le compilateur C# lui-même, et est idéal pour lorsque vous souhaitez vérifier vos commentaires avant de les compiler dans la documentation réelle , en utilisant par exemple Microsoft Sandcastle.

Dans la liste des fonctionnalités:

Vérifier sections vides. En option, Vérificateur de commentaires XML avertira si des sections ou éléments requis sont présents mais vides. Ce n'est pas activé par défaut

Utilisation de Visual Studio:

XML Commentaire Checker peut être défini comme l'événement après génération dans Visual Studio pour vérifier automatiquement un ensemble. Les avertissements émis par XML Commentaire Checker ont été formatés afin que Visual Studio les reconnaisse et les afficher dans la liste des erreurs. Une commande de post-construction ligne exemple: "PathToCommentChecker \ CommentChecker.exe" "$ (TargetPath)" -nologo -warnemptysections

Answer 4

Vous pouvez utiliser un fichier XSLT et déboguer le fichier XML contre le fichier XSLT, puis il lancera une erreur si le fichier XML n'est pas bien formé en vous montrant le numéro de ligne exact pour lequel le XML n'est pas bien formé. Ce fichier XSLT simple, ŒUVRES

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