Elegir identificadores de diagnóstico

Un identificador de diagnóstico es la cadena asociada a un diagnóstico determinado, como un error del compilador o un diagnóstico generado por un analizador.

Los identificadores se obtienen desde varias API, como:

• DiagnosticDescriptor.Id
• ObsoleteAttribute.DiagnosticId
• ExperimentalAttribute.DiagnosticId

Los identificadores de diagnóstico también se usan como identificadores en el código fuente, por ejemplo, de #pragma warning disable o archivos .editorconfig.

Consideraciones

• Los identificadores de diagnóstico deben ser únicos
• Los identificadores de diagnóstico deben ser identificadores legales en C#
• Los identificadores de diagnóstico deben tener menos de 15 caracteres de longitud
• Los identificadores de diagnóstico deben tener el formato <PREFIX><number>
  • El prefijo es específico del proyecto
  • El número representa el diagnóstico específico

Nota:

Cambiar los identificadores de diagnóstico es un cambio importante en el código fuente, ya que las supresiones existentes se omitirán si el identificador ha cambiado.

No limite el prefijo a dos caracteres (como CSXXX y CAXXXX). En su lugar, use un prefijo más largo para evitar conflictos. Por ejemplo, los diagnósticos de System.* usan SYSLIB como prefijo.