Выбор идентификаторов диагностики

Идентификатор диагностики — это строка, связанная с данной диагностикой, например ошибка компилятора или диагностика, созданная анализатором.

Идентификаторы извлекаются из различных API, таких как:

Идентификаторы диагностики также используются в качестве идентификаторов в источнике, например, из #pragma warning disable или .editorconfig файлов.

Соображения

  • Идентификаторы диагностики должны быть уникальными
  • Идентификаторы диагностики должны быть допустимыми идентификаторами в C#
  • Идентификаторы диагностики должны содержать менее 15 символов
  • Идентификаторы диагностики должны иметь форму <PREFIX><number>
    • Префикс зависит от проекта
    • Число представляет конкретную диагностику

Замечание

Изменение диагностических идентификаторов приводит к разрушительным последствиям для исходного кода, поскольку существующие подавления будут игнорироваться, если идентификатор изменится.

Не ограничивайте префикс двумя символами (например CSXXX, и CAXXXX). Вместо этого используйте более длинный префикс, чтобы избежать конфликтов. Например, диагностики System.* используют SYSLIB в качестве префикса.

  • Last updated on