Recherche du contenu de commentaires XML manquant avec Visual Studio

StackOverflow https://stackoverflow.com/questions/264623

  •  06-07-2019
  •  | 
  •  

Question

Tout au long du code source C #, nous avons beaucoup de commentaires qui manquent le contenu réel tel que celui-ci: 

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

ou ceci: 

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

ou ceci: 

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

Malheureusement, Visual Studio ne génère pas d'avertissements pour ce type de commentaires manquants. Mais pour nous, il serait bien que nous puissions simplement cliquer sur un élément de la liste (par exemple, la liste des avertissements) dans Visual Studio, puis le placer dans l’emplacement défectueux du code source pour le corriger. En outre, il serait agréable de voir la liste du contenu de commentaire xml manquant à chaque génération de fichiers xml. Avez-vous une idée sur la façon de réaliser cela?

Était-ce utile?

La solution 2

ReSharper est la réponse à cette lacune (comme beaucoup d’autres) de Visual Studio. Je n'ai que de la pitié pour quiconque ne l'utilise pas. ;)

Autres conseils

Essayez le vérificateur de commentaires XML :

  

XML Comment Checker est une application.   cela vérifiera la documentation XML   pour un assemblage .Net pour omissions. Il   offre une vérification plus complète   que le compilateur C # lui-même, et est   idéal pour vérifier votre   commentaires avant de les compiler dans   documentation réelle, par exemple en utilisant   Microsoft Sandcastle.

Dans la liste des fonctionnalités:

  

Recherchez les sections vides. éventuellement,   Le vérificateur de commentaires XML avertira si   des sections ou des éléments requis   sont présents, mais vides. Ce n'est pas   activé par défaut

Utilisation à partir de Visual Studio:

  

Le vérificateur de commentaires XML peut être défini comme   événement post-build dans Visual Studio pour   vérifier un assemblage automatiquement. Le   avertissements émis par XML Comment   Checker ont été formatés pour que   Visual Studio les reconnaîtra et   affichez-les dans la liste des erreurs. Un   exemple de ligne de commande post-build:   " PathToCommentChecker \ CommentChecker.exe "   " $ (TargetPath) " -Pas de logo   -warnemptysections

FxCop et une règle personnalisée?

Vous pouvez utiliser un fichier XSLT et déboguer le fichier XML avec le fichier XSLT. Il générera une erreur si le fichier XML n'est pas bien formé et vous indique le numéro de ligne exact par rapport auquel le fichier XML n'est pas bien formé. Ce fichier XSLT simple fonctionne - 

<?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>
Licencié sous: CC-BY-SA avec attribution
Non affilié à StackOverflow
scroll top