StyleCop抑制

Question

是否有可能在更全球化的环境中抑制StyleCop规则...换句话说，不只是使用源代码的内联属性？

Answer 1

您可以对Settings.StyleCop文件禁用某些样式复制规则。例如，某些内置到样式中的东西并不符合我们的标准。例如，在我的Settings.StyleCop文件中，我们有：

<Analyzer AnalyzerId="Microsoft.StyleCop.CSharp.ReadabilityRules">
  <Rules>
    <Rule Name="PrefixLocalCallsWithThis">
      <RuleSettings>
        <BooleanProperty Name="Enabled">False</BooleanProperty>
      </RuleSettings>
    </Rule>
  </Rules>
  <AnalyzerSettings />
</Analyzer>

这样，在成员变量或属性上，我们就不必使用“this”。对每一个人来说。

Answer 2

绝对一点儿没错!

源属性应该只在最罕见的情况下使用，绝大多数StyleCop配置应该通过StyleCopSettingsEditor完成(右键单击项目，选择"StyleCop设置“，这将打开一个设置)。

这将在项目目录中为该项目创建一个Settings.StyleCop文件。正如其他答案提到的那样，可以手动编辑该文件，但我永远不会建议在编辑器中修改XML。StyleCopSettingsEditor绝对是个不错的选择。

一旦你修改了你的StyleCop设置，你还没有完成！

这些设置将仅应用于该项目，这可能肯定是不够的。

我个人建议将该StyleCop.Settings文件上移一个目录到解决方案级别，并将其添加为“解决方案项”。然后将该文件签入到TFS (或您正在使用的任何源代码控制系统)中。现在，这些StyleCop设置是整个解决方案的一部分，每个人都会在执行“获取最新版本”时获得它们。如有必要，可以用项目设置重写解决方案设置(项目级别的StyleCop.Settings文件将重写解决方案级别的文件)。

使您的StyleCop设置更具全局性的唯一方法是在目录树中将它们向上移动到更高的位置(如果您正在使用TFS，则向上移动到团队项目级别，这是不可靠的，因为在解决方案级别执行GetLatest不会将它们分发给每个人)，或者覆盖StyleCop安装目录中的Settings.StyleCop文件(甚至更不可靠，因为这不能由源代码控制处理，而必须通过电子邮件发送给每个人或某事)。

总而言之，肯定有一些方法可以让您的团队的特定StyleCop设置像您想要的那样全球化，您有很多选择。