Udostępnij za pośrednictwem

Wybieranie identyfikatorów diagnostycznych

  • Artykuł

Identyfikator diagnostyczny to ciąg skojarzony z daną diagnostyką, taki jak błąd kompilatora lub diagnostyka utworzona przez analizator.

Identyfikatory są udostępniane z różnych interfejsów API, takich jak:

Identyfikatory diagnostyczne są również używane jako identyfikatory w źródle, na przykład z #pragma ostrzeżenia wyłącz lub pliki .editorconfig .

Kwestie wymagające rozważenia

  • Identyfikatory diagnostyczne powinny być unikatowe
  • Identyfikatory diagnostyczne muszą być identyfikatorami prawnymi w języku C#
  • Identyfikatory diagnostyczne powinny być krótsze niż 15 znaków
  • Identyfikatory diagnostyczne powinny mieć postać <PREFIX><number>
    • Prefiks jest specyficzny dla projektu
    • Liczba reprezentuje określoną diagnostykę

Uwaga

Jest to zmiana powodująca niezgodność źródła w celu zmiany identyfikatorów diagnostycznych, ponieważ istniejące pomijania byłyby ignorowane w przypadku zmiany identyfikatora.

Nie ograniczaj prefiksu do dwóch znaków (takich jak CSXXXi CAXXXX). Zamiast tego użyj dłuższego prefiksu, aby uniknąć konfliktów. Na przykład diagnostyka System.* używa SYSLIB jako prefiksu.