Choisir des ID de diagnostic

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

Les ID sont exposés depuis différentes API, comme :

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

Les ID de diagnostic sont également utilisés comme identificateurs dans la source, par exemple depuis les fichiers #pragma warning disable ou .editorconfig.

À propos de l’installation

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

Notes

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

Ne limitez pas votre préfixe à deux caractères (comme CSXXX et CAXXXX). Préférez un préfixe plus long, pour éviter les conflits. Par exemple, les diagnostics System.* utilisent SYSLIB comme préfixe.