Trovare contenuti mancanti di commenti XML con Visual Studio

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

  •  06-07-2019
  •  | 
  •  

Domanda

Nel codice sorgente o C # abbiamo molti commenti che mancano al contenuto reale come questo: 

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

o questo: 

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

o questo: 

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

Purtroppo Visual Studio non genera avvisi per questo tipo di commenti mancanti. Ma per noi sarebbe bello se potessimo semplicemente fare clic su un elemento in un elenco (ad esempio l'elenco degli avvisi) all'interno di Visual Studio e quindi essere portati nella posizione errata nel codice sorgente per correggerlo. Inoltre sarebbe bello vedere l'elenco dei contenuti mancanti dei commenti XML su ogni build dei file XML. Hai idea di come raggiungere questo obiettivo?

È stato utile?

Soluzione 2

ReSharper è la risposta a questo (come molti altri) difetto di Visual Studio. Non ho altro che pietà per chiunque non lo usi. ;)

Altri suggerimenti

Prova Controllo commenti XML :

  

XML Comment Checker è un'applicazione   che controllerà la documentazione XML   per un assembly .Net per omissioni. esso   offre un controllo più completo   rispetto al compilatore C # stesso, ed è   ideale per quando si desidera controllare il proprio   commenti prima di compilarli in   documentazione reale, ad es. utilizzo   Microsoft Sandcastle.

Dall'elenco delle funzionalità:

  

Cerca sezioni vuote. Facoltativamente,   Controllo commenti XML avviserà se presente   delle sezioni o degli elementi richiesti   sono presenti, ma vuoti. Questo non è   abilitato per impostazione predefinita

Utilizzo da Visual Studio:

  

Controllo commenti XML può essere impostato come   evento post-build in Visual Studio a   controllare automaticamente un assieme. Il   avvisi emessi dal commento XML   Il correttore è stato formattato in modo tale   Visual Studio li riconoscerà e   visualizzarli nell'elenco degli errori. Un   riga di comando post-build di esempio:   & Quot; PathToCommentChecker \ CommentChecker.exe "   " $ (TargetPath) " -nologo   -warnemptysections

FxCop e una regola personalizzata?

È possibile utilizzare un file XSLT ed eseguire il debug dell'xml rispetto al file XSLT e quindi genererà un errore se l'xml non è ben formato mostrandoti il ??numero esatto di riga rispetto al quale l'xml non è ben formato. Questo semplice file XSLT funziona- 

<?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>
Autorizzato sotto: CC-BY-SA insieme a attribuzione
Non affiliato a StackOverflow
scroll top