Freigeben über


Auswählen von Diagnose-IDs

Eine Diagnose-ID ist die Zeichenfolge, die einer bestimmten Diagnose zugeordnet ist, z. B. einem Compilerfehler oder einer Diagnose, die von einem Analyzer erstellt wird.

Die IDs werden über verschiedene APIs bereitgestellt, z. B.:

Diagnose-IDs werden auch als Bezeichner in der Quelle 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 in der Form <PREFIX><number> vorliegen.
    • Das Präfix ist spezifisch für Ihr Projekt.
    • Die Zahl stellt die spezifische Diagnose dar.

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 Ihr Präfix nicht auf zwei Zeichen (wie CSXXX und CAXXXX). Verwenden Sie stattdessen ein längeres Präfix, um Konflikte zu vermeiden. Beispielsweise verwenden die System.* Diagnosen SYSLIB als ihr Präfix.