Scegliere gli ID di diagnostica

  • Articolo

Un ID di diagnostica è la stringa associata a una determinata diagnostica, ad esempio un errore del compilatore o una diagnostica prodotta da un analizzatore.

Gli ID vengono esposti da varie API, ad esempio:

Gli ID di diagnostica vengono usati anche come identificatori nel codice sorgente, ad esempio da #pragma warning disable o dai file con estensione editorconfig.

Considerazioni

  • Gli ID di diagnostica devono essere univoci
  • Gli ID di diagnostica devono essere identificatori validi in C#
  • Gli ID di diagnostica devono avere una lunghezza inferiore a 15 caratteri
  • Gli ID di diagnostica devono essere nel formato <PREFIX><number>
    • Il prefisso è specifico del progetto
    • Il numero rappresenta la diagnostica specifica

Nota

La modifica degli ID di diagnostica è una modifica che causa un'interruzione nel codice sorgente, perché le eliminazioni esistenti vengono ignorate in caso di modifica dell'ID.

Non limitare il prefisso a due caratteri (ad esempio, CSXXX e CAXXXX). Usare in alternativa un prefisso più lungo per evitare conflitti. Ad esempio, la diagnostica System.* usa SYSLIB come prefisso.