Как подавить сообщения анализа кода для всех членов типа?

Question

Скажем, у меня есть перечисление всех валют:

public enum CurrencyType 
{ 
    /// <summary> 
    /// United Arab Emirates dirham 
    /// </summary> 
    [EnumMember] 
    AED = 784, 

    /// <summary> 
    /// Afghan afghani 
    /// </summary> 
    [EnumMember] 
    AFN = 971, 

    /// <summary> 
    /// Albanian lek 
    /// </summary> 
    [EnumMember] 
    ALL = 008, 

    ... 
} 

VS 2015 анализ кода продолжает жалуясь 100 нарушений CA1709 для каждого отдельного члена.

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

Я могу подавить сообщение; однако VS предлагает только подавить его для каждого отдельного участника - это означает, что у меня будет 100 линий [SuppressMessage(...)], что загромождает код.

Есть ли способ подавить все CA1709 для всех членов CurrencyType, не подавляя его для всего остального кода в этом проекте, без необходимости писать 100 [SuppressMessage(...)]?

Параметр ScopeSuppressMessageAttribute, но документация на нем неясна. Я попытался размещения как

[SuppressMessage("Microsoft.Naming", "CA1709:IdentifiersShouldBeCasedCorrectly", Scope = "type", Justification = "Currency codes are defined in ISO standard.")] 

и

[SuppressMessage("Microsoft.Naming", "CA1709:IdentifiersShouldBeCasedCorrectly", Scope = "member", Justification = "Currency codes are defined in ISO standard.")] 

на самом CurrencyType. Не работает.

Answer 1

В этом случае невозможно исключить правило для всего класса или перечисления, и к сожалению, подавление распространяется на всех его членов.

Но что вы можете сделать, это создать CodeAnalaysisDictionary.xml, добавьте его в свой проект, содержащий Enum и настройки его «Построить действие» Собственость к CodeAnalysisDictionary:

После того, как вы установили это вверх, вы можете добавить сокращения и исключения случая к словарю, как это:

<Dictionary> 
     <Acronyms> 
     <CasingExceptions> 
      <Acronym>AED</Acronym> 
      <Acronym>AFN</Acronym> 
      <Acronym>ALL</Acronym> 
      <Acronym>...</Acronym> 
     </CasingExceptions> 
     </Acronyms> 
</Dictionary> 

Хотя эти исключения будут применяться к любому элементу в коде с этими аббревиатурами в них, они будут предварительно отключите предупреждения CA1709.

Смотрите документацию для получения дополнительной информации об исключениях вы можете установить с помощью словарей:

• https://msdn.microsoft.com/en-us/library/bb514188.aspx#bkmk_dictionaryacronymscasingexceptionsacronym

Answer 2

Нет, нет никакого способа сделать это без индивидуальных подавлений. Аргумент Scope позволяет механизму анализа кода знать, что представляет собой аргумент Target. Например, если Target является «A.B.C», ссылается ли это на пространство имен с именем A.B.C или класс с именем C в пространстве имен A.B? «Область», возможно, была бы лучше представлена ​​таким именем, как «TargetKind», но это, к сожалению, не меняет того, что оно на самом деле представляет.

Учитывая уродство из подавленных в этом случае, вы можете создавать их в GlobalSuppressions.cs, а затем переместить их в отдельный файл, как CurrencyTypeMemberNameSuppressions.cs, который вы могли бы (при необходимости) гнезда в виде файла под файл, содержащий ваше CurrencyType перечисления в вашей структуре проекта в Visual Studio. Не идеально, но, возможно, лучший выбор плохой много в этой точке ...

Answer 3

Если перечисление находится в отдельном файле, вы можете подавить сообщения на уровне класса, как так (MSDN пример):

#define CODE_ANALYSIS 
using System; 
using System.Diagnostics.CodeAnalysis; 

namespace CodeAnalysisSample 
{ 
    class Library 
    { 
     [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "isChecked")] 
     [SuppressMessage("Microsoft.Performance", "CA1804:RemoveUnusedLocals", MessageId = "fileIdentifier")] 
     static void FileNode(string name, bool isChecked) 
     { 
      string fileIdentifier = name; 
      string fileName = name; 
      string version = String.Empty; 
     } 

    } 
} 

Проверьте следующую ссылку. должно быть полезно: https://msdn.microsoft.com/en-us/library/system.diagnostics.codeanalysis.suppressmessageattribute(v=vs.110).aspx