Partilhar via


Escolher IDs de diagnóstico

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.

Os IDs são apresentados a partir de várias APIs, como:

Os IDs de diagnóstico também são usados como identificadores na origem, por exemplo, a partir de #pragma aviso disable ou arquivos .editorconfig .

Considerações

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

Nota

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

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