Partage via


Choisir des ID de diagnostic

Un ID de diagnostic est la chaîne associée à un diagnostic donné, comme une erreur du compilateur ou un diagnostic généré par un analyseur.

Les identifiants sont révélés à partir de différentes API, telles que :

Les ID de diagnostic sont également utilisés comme identificateurs dans le code source, par exemple à partir de #pragma warning disable ou .editorconfig.

Considérations

  • Les ID de diagnostic doivent être uniques
  • Les ID de diagnostic doivent être des identificateurs juridiques en C#
  • Les ID de diagnostic doivent être inférieurs à 15 caractères
  • Les identifiants de diagnostic doivent avoir le format <PREFIX><number>
    • Le préfixe est spécifique à votre projet
    • Le nombre représente le diagnostic spécifique

Remarque

Il s’agit d’un changement cassant source pour modifier les ID de diagnostic, car les suppressions existantes seraient ignorées si l’ID a changé.

Ne limitez pas votre préfixe à deux caractères (par exemple, et CSXXXCAXXXX). Utilisez plutôt un préfixe plus long pour éviter les conflits. Par exemple, les diagnostics System.* utilisent SYSLIB comme préfixe.