Encontrar faltando conteúdo comentários XML com o Visual Studio

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

  •  06-07-2019
  •  | 
  •  

Pergunta

Ao longo ou C # código fonte temos um monte de comentários que perca o real conteúdo tais como este: 

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

ou este: 

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

ou este: 

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

Infelizmente Visual Studio não gera avisos para este tipo de falta de comentários. Mas para nós seria bom se pudéssemos Klick em um item em uma lista (por exemplo. A lista Warings) dentro do Visual Studio e, em seguida, ser levado para o local com defeito no código-fonte para corrigi-lo. Também seria bom ver a lista de desaparecidos comentário xml conteúdo sobre cada compilação dos arquivos XML. Você tem alguma idéia de como conseguir isso?

Foi útil?

Solução 2

ReSharper é a resposta para isso (como muitos outros) lacuna do Visual Studio. Eu não tenho nada, mas pena para quem não usá-lo. ;)

Outras dicas

Tente XML Comentário Checker :

XML Comentário Checker é uma aplicação que irá verificar a documentação XML para uma montagem Net para omissões. isto oferece uma verificação mais abrangente que o compilador C # si mesmo, e é ideal para quando você deseja verificar o seu comentários antes de compilá-los em documentação real, por exemplo usando Microsoft Sandcastle.

A partir da lista de recursos:

Verificar seções vazias. Opcionalmente, Comentário XML Checker irá avisar se houver das secções ou elementos necessários estão presentes, mas vazio. Isso não é ativado por padrão

Uso do Visual Studio:

XML Comentário Checker pode ser definido como o evento pós-compilação no Visual Studio para verificar uma montagem automática. A avisos emitidos por Comentário XML Checker foram formatados de modo que Visual Studio irá reconhecê-los e exibi-los na lista de erros. A exemplo linha de comando pós-compilação: "PathToCommentChecker \ CommentChecker.exe" "$ (TargetPath)" -nologo -warnemptysections

FxCop e uma regra personalizada?

Você pode usar um arquivo XSLT e depurar a xml contra o arquivo XSLT e, em seguida, ele irá lançar erro se o XML não está bem formado mostrando-lhe o número da linha exata contra a qual o XML não está bem formado. Este arquivo XSLT simples funciona - 

<?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>
Licenciado em: CC-BY-SA com atribuição
Não afiliado a StackOverflow
scroll top