Compartilhar via

Escolher IDs de diagnóstico

  • Artigo

Uma ID de diagnóstico é a cadeia de caracteres associada a um determinado diagnóstico, como um erro do compilador ou um diagnóstico produzido por um analisador.

As IDs são exibidas de várias APIs, como:

As IDs de diagnóstico também são usadas como identificadores na origem, por exemplo, de arquivos de desativação de aviso #pragma ou .editorconfig.

Considerações

  • As IDs de diagnóstico devem ser exclusivas
  • As IDs de diagnóstico devem ser identificadores legais em C#
  • As IDs de diagnóstico devem ter menos de 15 caracteres
  • As IDs de diagnóstico devem ter o formato <PREFIX><number>
    • O prefixo é específico do seu projeto
    • O número representa o diagnóstico específico

Observação

É uma alteração de falha de origem para alterar as IDs de diagnóstico, pois as supressões existentes seriam ignoradas se a ID fosse alterada.

Não limite o seu prefixo a dois caracteres (como CSXXXe CAXXXX). Em vez disso, use um prefixo mais longo para evitar conflitos. Por exemplo, o diagnóstico System.* usa SYSLIB como prefixo.