CA1500 与 SA1309 - 哪一个获胜？

Question

我首先要说的是，我理解代码分析和 StyleCop 都是指导方针，但许多人还是选择忽略这些。但话虽如此，我想看看对于这两条规则的普遍共识是什么。

规则 CA1500 规定不要使参数名称和私有字段名称相同。

另一方面，规则 SA1309 规定不要在成员前添加下划线或“米_”。

这使得我们几乎没有选择来区分私有支持字段与其相应的参数。以这些例子为例。

SA1309 抱怨：

class SomeClass
{
    int _someField;

    public SomeClass(int someField)
    {
        this._someField = someField;
    }
}

CA1500 抱怨：

class SomeClass
{
    int someField;

    public SomeClass(int someField)
    {
        this.someField = someField;
    }
}

我有什么选择？我不想将私有支持字段设为 PascalCase，因为这是公共字段/属性的（我相信相当普遍）约定。我不想重命名其中之一，只是为了解决歧义。

因此，我只剩下上述两条规则之一，这需要我取消 SA/CA 规则之一。

你们通常做什么？更重要的是，这些规则的作者认为您应该做什么（因为他们的文档中都没有提供替代解决方案）？

Answer 1

我们关闭SA1309。其背后的推理相当薄弱。

我们的团队认为，私人成员以下划线开头的广为接受的做法远远超过了有人可能在代码上使用不同编辑器的想法，无论如何，这种情况在我们的商店中从未发生过。至于提供“立即区分”，下划线也能做到这一点。

如果您确实有开发人员仍然使用“m_”，并且您仍然需要检查这一点，您可以为此编写一个快速规则。

Answer 2

根据我从 Microsoft 那里看到的情况，我认为 CA1500 获胜。

如果您查看 BCL，您会发现大多数代码都在本地字段前添加下划线。

Answer 3

这是我通常的解决方案：

class SomeClass
{
    int SomeField{get;set;}

    public SomeClass(int someField)
    {
        SomeField = someField;
    }
}

Answer 4

我能想到的唯一替代方案似乎可以满足这两个规则，并且我实际上在任何地方都看到过它的使用，如下所示。我自己并不遵循这个惯例，因为它看起来很笨拙。

public class Class1
{
    // prefix private fields with "m"
    private int mValue1;

    public int Value1
    {
        get { return mValue1; }
        set { mValue1 = value; }
    }

    private string mValue2;

    public string Value2
    {
        get { return mValue2; }
        set { mValue2 = value; }
    }

    // prefix parameters with "p"
    public bool PerformAction(int pValue1, string pValue2)
    {
        if (pValue1 > mValue1)
        {
            mValue2 = pValue2;
            return true;
        }
        else
        {
            return (mValue2 == pValue2);
        }
    }
}

Answer 5

很简单，当存在类时，对私有字段使用后缀“Field”：

 private Int32 counterField;

 public Int32 Counter
 {
     get
     {
          return this.counterField;
     }

     set
     {
           if (this.counterField != value)
           {
                this.counterField = value;
                this.OnPropertyChanged("Counter");
            }
      }

并且您可以满足这两个规则。用任何字符或匈牙利语前缀修饰变量都是部落式的。每个人都可以在 StyleCop 或 FXCop 中找到他们不喜欢的规则，但标准只有在每个人都使用它时才有效。自动代码清理器的好处远远超过您个人对语言的“艺术”贡献。

Answer 6

没有冲突。更改参数名称。

public class SomeClass
{
    private int namedField { get; set; }

    public SomeClass(int differentlyNamedField)
    {
        this.namedField = differentlyNamedField;
    }
}