如何解决违反 StyleCop SA1305 的问题（匈牙利语）

Question

我的代码包含一个名为“m_d3dDevice”的变量。

StyleCop 抱怨这个名字：

SA1305：变量名 'm_d3dDevice' 以前缀开头 看起来像匈牙利表示法。 删除前缀或将其添加到 允许的前缀列表。

（请注意，我已手动禁用 SA1308（“m_”），这是我愿意违反的少数规则之一。）

我不能允许“d3d”作为匈牙利语选项卡中的例外，因为它只允许 1 或 2 个字符前缀，并且允许“d3”没有帮助。我已经尝试了所有我能想到的将“d3d”添加到我的 CustomDictionary 文件中（无论如何，文档暗示 CustomDict 不用于规则 1305）。

有什么建议可以让 StyleCop 允许这样做吗？现在不必 F2 我的变量是一件值得自豪的事情。

Answer 1

您还可以根据具体情况抑制 stylecop。例如，

[System.Diagnostics.CodeAnalysis.SuppressMessage(
    "Microsoft.StyleCop.CSharp.NamingRules",
    "SA1305:FieldNamesMustNotUseHungarianNotation",
    Justification = "Using Win32 naming for consistency.")]
IntPtr hFile;

如果您有许多令人不快的名字，这可能不是一个有吸引力的选择，但对于一两个，通常没问题。

Answer 2

您还可以使用包文件中的 Settings.StyleCop 来配置设置。

您可以通过将以下代码添加到 Settings.StyleCop 文件来抑制特定单词：

<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>ip</Value>
      <Value>is</Value>
      <Value>mx</Value>
      <Value>my</Value>
      <Value>no</Value>
      <Value>on</Value>
      <Value>to</Value>
      <Value>ui</Value>
      <Value>vs</Value>
      <Value>x</Value>
      <Value>y</Value>
      <Value>z</Value>
      <Value>iOS</Value>
      <Value>IOS</Value>
    </CollectionProperty>
  </AnalyzerSettings>
</Analyzer>

您可以通过将以下代码添加到 Settings.StyleCop< 来抑制 Hungarain 规则本身/代码> 文件

<Analyzer AnalyzerId="StyleCop.CSharp.NamingRules">
  <Rules>
   <Rule Name="FieldNamesMustNotUseHungarianNotation">
    <RuleSettings>
     <BooleanProperty Name="Enabled">
        False
     </BooleanProperty>
    </RuleSettings>
   </Rule>
 </Rules>
</Analyzer>

Answer 3

你可以看看我的工具，StyleCop+。它包含灵活的命名规则，允许您强制所有私有字段以“m_”（或您希望的任何内容）开头命名，而不是禁用名称检查（就像您所做的那样）。

关于“d3dDevice”——这是一个非常有趣的案例。从逻辑上讲，它分为以下单词 - { "d", "3", "d", "Device" } 或 { "d3", "d", "Device" }。第二个“d”似乎不遵循“camelNotation”。

但我坚信静态分析（特别是命名）应该足够灵活，以满足用户的需求。目前，StyleCop+ 可以通过以下方式支持您的情况 - 例如，您可以将“例外”（任意数量）添加到私有字段的命名模板中，以便它看起来像：

m_$(aaBb)
m_d3d$(AaBb)

这更有可能是解决方法，但我会考虑你的“d3d”案例 - 也许 StyleCop+ 会支持这样的东西。

Answer 4

添加抑制属性应该在所有方法之上完成，这将需要时间和漫长的过程。

如果您想从项目中删除此规则，请尝试此

• 操作 右键单击​​您的项目
• 选择 Stylecop 设置
• 查找 SA1305
• 从结果集中取消选中该规则
• 单击应用 - 确定
• 再次重新运行样式 cop 规则。