Encontrar contenido de comentarios XML faltantes con Visual Studio
-
06-07-2019 - |
Pregunta
En todo el código fuente de C # tenemos muchos comentarios que pierden el contenido real como este:
/// <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 hacer clic en un elemento de una lista (por ejemplo, la lista de advertencias) dentro de Visual Studio y luego ser llevado a la ubicación defectuosa en el código fuente para corregirlo. También sería bueno ver la lista de contenido de comentarios xml faltantes en cada compilación de los archivos xml. ¿Tienes alguna idea sobre cómo lograr esto?
Solución 2
ReSharper es la respuesta a esta (como muchas otras) deficiencias de Visual Studio. No tengo nada más que lástima por cualquiera que no lo use. ;)
Otros consejos
Pruebe Comprobador de comentarios XML :
XML Comment Checker es una aplicación eso verificará la documentación XML para un ensamblaje .Net para omisiones. Eso ofrece una comprobación más completa que el compilador de C # en sí, y es ideal para cuando deseas revisar tu comentarios antes de compilarlos en documentación real, por ejemplo, usando Microsoft Sandcastle.
De la lista de características:
Buscar secciones vacías. Opcionalmente, XML Comment Checker le avisará si hay alguno de las secciones o elementos requeridos están presentes, pero vacíos. Esto no es habilitado por defecto
Uso de Visual Studio:
XML Comment Checker se puede establecer como evento posterior a la compilación en Visual Studio para Verifique un ensamblaje automáticamente. El advertencias emitidas por XML Comentario El verificador ha sido formateado para que Visual Studio los reconocerá y mostrarlos en la Lista de errores. Un ejemplo de línea de comando posterior a la compilación: " PathToCommentChecker \ CommentChecker.exe " " $ (TargetPath) " -Sin logo -warnemptysections
FxCop y una regla personalizada?
Puede usar un archivo XSLT y depurar el xml contra el archivo XSLT y luego arrojará un error si el xml no está bien formado y le muestra el número de línea exacto contra el cual el xml no está bien formado. Este simple archivo XSLT 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>