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

  • Статья

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

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

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

Рекомендации

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

Примечание.

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

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