Auswählen von Diagnose-IDs

  • Artikel

Eine Diagnose-ID ist die Zeichenfolge, die einer bestimmten Diagnose zugeordnet ist, z. B. einem Compiler-Fehler oder einer Diagnose, die von einem Analysetool erzeugt wird.

Die IDs stammen aus verschiedenen APIs, wie z. B.:

Diagnose-IDs werden auch als Bezeichner im Quellcode verwendet, z. B. aus #pragma warning disable- oder .editorconfig-Dateien.

Überlegungen

  • Diagnose-IDs sollten eindeutig sein
  • Diagnose-IDs müssen in C# legale Bezeichner sein
  • Diagnose-IDs sollten weniger als 15 Zeichen lang sein
  • Diagnose-IDs sollten die Form <PREFIX><number> aufweisen
    • Das Präfix ist spezifisch für Ihr Projekt
    • Die Zahl steht für die spezifische Diagnose

Hinweis

Das Ändern der Diagnose-IDs würde den Quellcode beschädigen, da bestehende Unterdrückungen doppelter Warnungen ignoriert würden, wenn sich die ID ändert.

Beschränken Sie das Präfix nicht auf zwei Zeichen (z. B. CSXXX und CAXXXX). Verwenden Sie stattdessen ein längeres Präfix, um Konflikte zu vermeiden. Beispielsweise verwendet die System.*-Diagnose SYSLIB als Präfix.