Как сделать так, чтобы для некоторого класса или метода игнорировалось определенное правило (rule) StyleCop?
Отмена проверки правила StyleCop для класса или метода
1
Спросил
Лучший ответ:
1
Начиная с версии 4.3.2, StyleCop поддерживает возможность игнорирования правила с помощью стандартного атрибута SuppressMessage
. Используется атрибут так:
[SuppressMessage("Категория правила",
"Идентификатор правила", Justification = "Пояснение")]
Где
- Категория правила — пространство имен, в котором определено правило, например,
Microsoft.StyleCop.CSharp.DocumentationRules
илиMicrosoft.StyleCop.CSharp.ReadabilityRules
- Идентификатор правила — уникальный идентификатор правила в формате
КраткоеИмя:ПолноеИмя
.КраткоеИмя
можно увидеть в списке ошибок/предупреждений, аПолноеИмя
придется искать в документации. Например,SA1600:ElementsMustBeDocumented
илиSA1118:ParameterMustNotSpanMultipleLines
- Пояснение — текст, поясняющий причину игнорирования правила.
Атрибут SuppressMessage может быть применен к классу или методу. При этом будут игнорироваться сообщения для всего класса или для отдельного метода соответственно.