Búsqueda de comentarios XML falta de contenido con Visual Studio

Question

lo largo o C# código fuente que tienen una gran cantidad de comentarios que se pierda el contenido real tales como esto:

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

o esto:

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

o esto:

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

Desafortunadamente Visual Studio no genera advertencias para este tipo de comentarios faltantes. Pero para nosotros sería bueno si pudiéramos simplemente presionar sobre un elemento de una lista (por ejemplo, la lista de warings) dentro de Visual Studio y luego llevarlo a la ubicación defectuosa en el código fuente para corregirlo. También sería bueno ver la lista de contenido de comentario XML faltante en cada compilación de los archivos xml. ¿Tienes alguna idea sobre cómo lograr esto?

Answer 1

ReSharper es la respuesta a esta (como muchos otros) deficiencia de Visual Studio . No tengo nada más que lástima para cualquiera que no lo use. ;)

Answer 2

FxCop y una regla personalizada?

Answer 3

Trate XML Comment Checker:

XML Comentario Checker es una aplicación que comprobará la documentación XML para un ensamblaje .Net por omisiones. Se ofrece una más completa comprobación que el compilador de C# en sí, y es ideal para cuando se desea comprobar sus comentarios antes de compilar ellos en documentación real, por ejemplo utilizando Microsoft castillo de arena.

En la lista de programas:

Compruebe si hay secciones vacías. Opcionalmente, XML Comment Checker advertirá si de las secciones o elementos necesarios están presentes, pero vacíos. Esto no es activado por defecto

Uso de Visual Studio:

XML comentario inspector se puede establecer como el evento posterior a la generación en Visual Studio para verificación de un montaje de forma automática. Las advertencias emitidas por XML Comentario El verificador se formateó para que Visual Studio las reconozca y las muestre en la Lista de errores. Un ejemplo línea de comandos posterior a la generación: "PathToCommentChecker \ CommentChecker.exe" "$ (targetPath)" -nologo -warnemptysections

Answer 4

Puede usar un archivo XSLT y depurar el xml contra el archivo XSLT y lanzará un error si el xml no está bien formado, mostrándole el número de línea exacto contra el cual el xml no está bien formado. Este archivo XSLT sencilla obras-

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