Suprime la advertencia para código C# generado

Question

He activado "Tratar advertencias como errores" para mi proyecto VS, lo que significa que recibo errores por falta de documentación (buen recordatorio para este proyecto en particular).

Sin embargo, parte del código es generado por una herramienta personalizada que no inserta documentación xml, así que estoy buscando ignorar la documentación xml que falta para el código generado solamente, no para todo el proyecto. No influyo en el archivo real generado y realmente no puedo insertar nada en el archivo (ya que la herramienta lo regenera frecuentemente) por lo que busco algo existente fuera del archivo generado (las clases que se generan son parciales, si eso ayuda)

Answer 1

EDITAR: Vea los comentarios que indican que no funciona con C# 4. No tengo claro si funcionó en versiones anteriores del compilador. Sin embargo, la especificación C# 4 deja esto bastante claro. Sección 2.5.8.1 establece que:

Un #pragma warning restore Directiva restaura la totalidad o el conjunto dado de advertencias al estado que estaba en vigor al comienzo de la unidad de compilación. Tenga en cuenta que si una advertencia en particular se deshabilitó externamente, un #pragma warning restore (ya sea para todos o para la advertencia especificada) no volverá a habilitar esa advertencia.

Jeff tiene un workaround in a blog post - básicamente para reprocesar el código autogenerado como parte de la compilación.

---

Como dice Tom, se puede añadir una "ignorar" a todo el proyecto (Build/reprimir Advertencias - entrar en 1591 como el número de aviso) - pero entonces se puede restaurar el mismo aviso en la parte superior de cada uno de sus archivos que no son generados:

#pragma warning restore 1591 

es bastante feo, pero funciona (yo sólo lo he probado).

Answer 2

Lo mejor que podrá hacer en esto es suprimir la advertencia particular en el proyecto que contiene el código generado. Puede hacer esto en Propiedades del proyecto en la pestaña Construir. No es ideal, pero a menos que pongas las pragmas en el código generado, es lo mejor que puedes hacer.

Answer 3

La mejor manera de evitar que tienen advertencias o errores de análisis de código en el código generado es para decorar sus clases generadas con el GeneratedCodeAttribute y hacer que el archivo de código termina con el patrón * .generated.cs.

Si los archivos de código también tienen un encabezado de archivo, debe tenía las siguientes etiquetas:

//---------------------- 
// <auto-generated> 
//  Tool description 
// </auto-generated> 
//---------------------- 

Esto no es obligatorio, pero si usted tiene cabecera del archivo de código es una buena práctica.

De esta manera, FxCop y otras herramientas como StyleCop ya no analizarán su código.

Lo anormal es que su herramienta de generación de código no está decortating sus elementos de código con el atributo mencionado anteriormente. Intente ver si hay una opción para activar en la configuración de su herramienta o póngase en contacto con el equipo en desarrollo.

---

EDIT: ¿El clases generadas son clases parciales y el nombre real de las clases y el número de cambios de frecuencia? Porque si el contenido del código generado no se mueve mucho, lo único que puede hacer es simplemente crear otro archivo de código y simplemente declarar la clase parcial generada para decorarlos con GeneratedCodeAttribute. Una vez me salvó la vida (¡y mi tiempo!).