Volba diagnostických ID

ID diagnostiky je řetězec přidružený k dané diagnostice, například chyba kompilátoru nebo diagnostika vytvořená analyzátorem.

ID se zobrazují z různých rozhraní API, například:

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

Diagnostická ID se také používají jako identifikátory ve zdroji, například ze #pragma upozornění zakázat nebo soubory .editorconfig .

Důležité informace

• Diagnostická ID by měla být jedinečná.
• Diagnostická ID musí být právní identifikátory v jazyce C.#
• Diagnostická ID by měla být kratší než 15 znaků.
• Diagnostická ID by měla být ve formuláři. <PREFIX><number>
  • Předpona je specifická pro váš projekt.
  • Číslo představuje konkrétní diagnostiku.

Poznámka:

Jedná se o změnu způsobující chybu zdroje pro změnu ID diagnostiky, protože existující potlačení by se při změně ID ignorovalo.

Neomeďte předponu na dva znaky (například CSXXXna ).CAXXXX Místo toho použijte delší předponu, abyste se vyhnuli konfliktům. Například System.* diagnostika se používá SYSLIB jako jejich předpona.