Отмена проверки правила StyleCop для класса или метода - CodeHelper

Отмена проверки правила StyleCop для класса или метода

1

Как сделать так, чтобы для некоторого класса или метода игнорировалось определенное правило (rule) StyleCop?

Лучший ответ:

1

Начиная с версии 4.3.2, StyleCop поддерживает возможность игнорирования правила с помощью стандартного атрибута SuppressMessage. Используется атрибут так:

[SuppressMessage("Категория правила", 
    "Идентификатор правила", Justification = "Пояснение")]

Где

  • Категория правила — пространство имен, в котором определено правило, например, Microsoft.StyleCop.CSharp.DocumentationRules или Microsoft.StyleCop.CSharp.ReadabilityRules
  • Идентификатор правила — уникальный идентификатор правила в формате КраткоеИмя:ПолноеИмя. КраткоеИмя можно увидеть в списке ошибок/предупреждений, а ПолноеИмя придется искать в документации. Например, SA1600:ElementsMustBeDocumented или SA1118:ParameterMustNotSpanMultipleLines
  • Пояснение — текст, поясняющий причину игнорирования правила.

Атрибут SuppressMessage может быть применен к классу или методу. При этом будут игнорироваться сообщения для всего класса или для отдельного метода соответственно.

v1.7.123.556
© 2009—2010 CodeHelper FAQ | О сайте | Обратная связь | История изменений | Статьи
Creative Commons LicenseМатериалы сайта распространяются под лицензией Creative Commons Attribution-Share Alike 3.0 Unported.