Блог

Главная - Вопросы по программированию - Как добавить подавление глобального правила предупреждения в файл StyleCop.Settings?

Как добавить подавление глобального правила предупреждения в файл StyleCop.Settings?

#visual-studio-2010 #configuration #warnings #stylecop #suppress-warnings

#visual-studio-2010 #конфигурация #предупреждения #stylecop #подавить-предупреждения

Вопрос:

Я получаю более 5 тысяч предупреждений StyleCop разных видов. Я использую Visual Studio 2010 Express edition, поэтому в меню нет пункта для перехода к StyleCop настройкам или для подавления предупреждений из Visual Studio. Единственный оставшийся вариант — отредактировать StyleCop.Settings файл, который я пытаюсь сделать atm, версия StyleCop, которую я использую, — 4.7.

Мой файл StyleCop.Settings выглядит следующим образом:

 <StyleCopSettings Version="4.3">
  <GlobalSettings>
    <CollectionProperty Name="DeprecatedWords">
      <Value>preprocessor,pre-processor</Value>
      <Value>shortlived,short-lived</Value>
    </CollectionProperty>
  </GlobalSettings>
  <Parsers>
    <Parser ParserId="StyleCop.CSharp.CsParser">
      <ParserSettings>
        <CollectionProperty Name="GeneratedFileFilters">
          <Value>.g.cs



lt;/Value>

          <Value>.generated.cs




lt;/Value>

          <Value>.g.i.cs




lt;/Value>

        </CollectionProperty>

      </ParserSettings>

    </Parser>

  </Parsers>

  <Analyzers>

    <Analyzer AnalyzerId="StyleCop.CSharp.NamingRules">

      <AnalyzerSettings>

        <CollectionProperty Name="Hungarian">

          <Value>as</Value>

          <Value>do</Value>

          <Value>id</Value>

          <Value>if</Value>

          <Value>in</Value>

          <Value>is</Value>

          <Value>my</Value>

          <Value>no</Value>

          <Value>on</Value>

          <Value>to</Value>

          <Value>ui</Value>

        </CollectionProperty>

      </AnalyzerSettings>

    </Analyzer>

  </Analyzers>

</StyleCopSettings>

 

Как мне нужно отредактировать файл настроек, чтобы подавить все предупреждения, которые находятся внутри  CSharp.Ordering  и  CSharp.Documentation  , или сделать это код за кодом ( SA1202, SA1600  )?Я не возражаю против любого решения.


 SA1202 : CSharp.Ordering : All private methods must be placed after all public methods.     
SA1600 : CSharp.Documentation : The method must have a documentation header.    
 




Ответ №1:




Решил сам, в вашей папке установки StyleCop, в той же папке, где  StyleCop.Settings  находится файл (в моем случае его C:Program FilesStyleCop 4.7  ).

Должен быть файл с именем  StyleCopSettingsEditor.exe  . Перетаскивание  StyleCop.Settings  на  StyleCopSettingsEditor.exe  это должно запустить приложение и открыть окно, показанное на скриншоте ниже.


введите описание изображения здесь


Вы можете редактировать настройки по группам или по определенному коду.


Для тех, кто по какой-либо причине не может использовать редактор, приведенный ниже XML показывает, как  StyleCop.Settings  выглядит файл после редактирования.


 <StyleCopSettings Version="105">
  <GlobalSettings>
    <CollectionProperty Name="DeprecatedWords">
      <Value>preprocessor,pre-processor</Value>
      <Value>shortlived,short-lived</Value>
    </CollectionProperty>
  </GlobalSettings>
  <Parsers>
    <Parser ParserId="StyleCop.CSharp.CsParser">
      <ParserSettings>
        <CollectionProperty Name="GeneratedFileFilters">
          <Value>.g.cs



lt;/Value>

          <Value>.generated.cs




lt;/Value>

          <Value>.g.i.cs




lt;/Value>

        </CollectionProperty>

      </ParserSettings>

    </Parser>

  </Parsers>

  <Analyzers>

    <Analyzer AnalyzerId="StyleCop.CSharp.NamingRules">

      <AnalyzerSettings>

        <CollectionProperty Name="Hungarian">

          <Value>as</Value>

          <Value>do</Value>

          <Value>id</Value>

          <Value>if</Value>

          <Value>in</Value>

          <Value>is</Value>

          <Value>my</Value>

          <Value>no</Value>

          <Value>on</Value>

          <Value>to</Value>

          <Value>ui</Value>

        </CollectionProperty>

      </AnalyzerSettings>

    </Analyzer>

    <Analyzer AnalyzerId="StyleCop.CSharp.DocumentationRules">

      <Rules>

        <Rule Name="ElementsMustBeDocumented">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="PartialElementsMustBeDocumented">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="EnumerationItemsMustBeDocumented">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="DocumentationMustContainValidXml">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="ElementDocumentationMustHaveSummary">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="PartialElementDocumentationMustHaveSummary">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="ElementDocumentationMustHaveSummaryText">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="PartialElementDocumentationMustHaveSummaryText">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="ElementDocumentationMustNotHaveDefaultSummary">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="ElementParametersMustBeDocumented">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="ElementParameterDocumentationMustMatchElementParameters">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="ElementParameterDocumentationMustDeclareParameterName">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="ElementParameterDocumentationMustHaveText">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="ElementReturnValueMustBeDocumented">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="ElementReturnValueDocumentationMustHaveText">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="VoidReturnValueMustNotBeDocumented">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="GenericTypeParametersMustBeDocumented">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="GenericTypeParametersMustBeDocumentedPartialClass">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="GenericTypeParameterDocumentationMustMatchTypeParameters">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="GenericTypeParameterDocumentationMustDeclareParameterName">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="GenericTypeParameterDocumentationMustHaveText">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="PropertySummaryDocumentationMustMatchAccessors">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="PropertySummaryDocumentationMustOmitSetAccessorWithRestrictedAccess">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="ElementDocumentationMustNotBeCopiedAndPasted">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="SingleLineCommentsMustNotUseDocumentationStyleSlashes">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="DocumentationTextMustNotBeEmpty">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="DocumentationTextMustContainWhitespace">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="DocumentationMustMeetCharacterPercentage">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="ConstructorSummaryDocumentationMustBeginWithStandardText">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="DestructorSummaryDocumentationMustBeginWithStandardText">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="DocumentationHeadersMustNotContainBlankLines">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="IncludedDocumentationXPathDoesNotExist">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="IncludeNodeDoesNotContainValidFileAndPath">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="InheritDocMustBeUsedWithInheritingClass">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="ElementDocumentationMustBeSpelledCorrectly">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="FileMustHaveHeader">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="FileHeaderMustShowCopyright">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="FileHeaderMustHaveCopyrightText">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="FileHeaderMustContainFileName">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="FileHeaderFileNameDocumentationMustMatchFileName">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="FileHeaderMustHaveValidCompanyText">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="FileHeaderFileNameDocumentationMustMatchTypeName">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

      </Rules>

      <AnalyzerSettings />

    </Analyzer>

    <Analyzer AnalyzerId="StyleCop.CSharp.OrderingRules">

      <Rules>

        <Rule Name="UsingDirectivesMustBePlacedWithinNamespace">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="ElementsMustAppearInTheCorrectOrder">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="ElementsMustBeOrderedByAccess">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="ConstantsMustAppearBeforeFields">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="StaticElementsMustAppearBeforeInstanceElements">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="DeclarationKeywordsMustFollowOrder">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="ProtectedMustComeBeforeInternal">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="PropertyAccessorsMustFollowOrder">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="EventAccessorsMustFollowOrder">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="StaticReadonlyElementsMustAppearBeforeStaticNonReadonlyElements">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

        <Rule Name="InstanceReadonlyElementsMustAppearBeforeInstanceNonReadonlyElements">

          <RuleSettings>

            <BooleanProperty Name="Enabled">False</BooleanProperty>

          </RuleSettings>

        </Rule>

      </Rules>

      <AnalyzerSettings />

    </Analyzer>

  </Analyzers>

</StyleCopSettings>

 









	Метки: