Diagnostische id's kiezen

Een diagnostische id is de tekenreeks die is gekoppeld aan een bepaalde diagnose, zoals een compilerfout of een diagnose die wordt geproduceerd door een analyse.

De id's worden uit verschillende API's weergegeven, zoals:

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

Diagnostische id's worden ook gebruikt als id's in de bron, bijvoorbeeld van #pragma waarschuwing uitschakelen of .editorconfig-bestanden .

Overwegingen

• Diagnostische id's moeten uniek zijn
• Diagnostische id's moeten juridische id's in C zijn#
• Diagnostische id's moeten minder dan 15 tekens lang zijn
• Diagnostische id's moeten van het formulier zijn <PREFIX><number>
  • Het voorvoegsel is specifiek voor uw project
  • Het getal vertegenwoordigt de specifieke diagnose

Notitie

Het is een brononderbrekingswijziging voor het wijzigen van diagnostische id's, omdat bestaande onderdrukkingen worden genegeerd als de id is gewijzigd.

Beperk uw voorvoegsel niet tot twee tekens (zoals CSXXXen CAXXXX). Gebruik in plaats daarvan een langer voorvoegsel om conflicten te voorkomen. De diagnostische gegevens worden SYSLIB bijvoorbeeld System.* gebruikt als voorvoegsel.