Dela via


Välj diagnostik-ID:t

Ett diagnostik-ID är strängen som är associerad med en viss diagnostik, till exempel ett kompilatorfel eller en diagnostik som skapas av en analysator.

ID:erna visas från olika API:er, till exempel:

Diagnostik-ID används också som identifierare i källkod, till exempel från #pragma warning disable eller .editorconfig-filer.

Överväganden

  • Diagnostik-ID:t ska vara unika
  • Diagnostik-ID:n måste vara giltiga identifierare i C#
  • Diagnostik-ID:t bör vara mindre än 15 tecken långa
  • Diagnostik-ID:n ska vara i formatet <PREFIX><number>
    • Prefixet är specifikt för projektet
    • Antalet representerar den specifika diagnosen

Anmärkning

Det är en källbrytande ändring för att ändra diagnostik-ID:t, eftersom befintliga undertryckningar ignoreras om ID:t ändrades.

Begränsa inte prefixet till två tecken (till exempel CSXXXoch CAXXXX). Använd i stället ett längre prefix för att undvika konflikter. Diagnostiken System.* använder SYSLIB till exempel som prefix.