仅大小写不同的 C# 自动实现属性和局部变量的最佳实践？

Question

让我举个例子：

public class MyClass
{
    public string MyProperty { get; set; }

    public MyClass(string myProperty)
    {
        MyProperty = myProperty; // bad?
        this.MyProperty = myProperty; // good?
    }
}

我在这种情况下开始使用 this ，因为我有轻微的偏执，认为单独依赖大小写可能会令人困惑，或者更糟糕的是可能会导致错误。

这里的“最佳实践”是什么？

编辑：

到目前为止，听起来这比我想象的要主观得多。我认为人们会强烈地站在一边或另一边。

Answer 1

在任何类中使用“this.”都是多余的。完全由您的开发团队来设定使用它的标准。

使用“this.”的优点是，一些开发人员发现在阅读代码时更容易将其与类实例联系起来，并且正如您提到的，在处理类似名称的项目。

缺点是有些人认为它会使您的代码文件变得混乱，如果您使用 ReSharper 等工具，他们会默认将其标记为冗余代码。

Answer 2

正如旺普所说。 “this”是多余的，但它使代码更易于阅读。或者说更难误读。

Answer 3

没有风险。

C# 绝对区分大小写，因此使用... MyProperty = myProperty;

因此，我会寻找其他最佳实践，例如编写实现目标所需的最少代码（同时进行自我记录）。事实是，这不是必需的，极简主义者可能会说忽略它。

Answer 4

以下是我目前如何使用您的示例初始化属性（自动实现和非自动实现），

        public class MyClass
    {
        public string MyProperty { get; set; }

        public string AnotherProperty
        {
            get { return _anotherProperty; }
            set { _anotherProperty = value; }
        }
        private string _anotherProperty;

        public MyClass(string myProperty, string anotherProperty)
        {
            MyProperty = myProperty; // auto-implemented property initialization
            _anotherProperty = anotherProperty; //property with member variable initialization                
        }
    }

使用“this”的点对我来说是过度规范。我知道它是本地财产，因为它是大写的。所有财产均应大写。由于下划线，我知道变量“_anotherProperty”具有类范围。我曾经省略类级变量中的下划线。当下划线存在时，代码对我来说更容易阅读，因为我立即知道范围，而无需将鼠标悬停在变量上以查看 VS 工具提示中的声明。另外，我还可以通过省略下划线来对局部变量使用相同的名称。这使得你的初始化看起来很干净。下划线的另一个好处是，您可以键入下划线并按 ctrl+space，所有类范围的变量都会被分组。

Answer 5

在我的工作场所，编码标准规定属性应这样编写，而局部变量应这样编写。由于 C# 区分大小写，因此这是一个很好的工具来区分变量。但是，如果您发现自己的属性和局部变量具有完全相同的名称，那么使用 this 关键字肯定会消除用法的歧义。

Answer 6

您的两个选择都仅依赖于大小写......两者之间没有区别。

Answer 7

在我看来，这里的“最佳实践”是“不要这样做”。如果我在正在审查的代码中遇到这个问题，我会立即标记它。两个仅因情况不同的变量是一种即将发生的误解。对于维护程序员来说，几个月或几年后，很容易无意中分配给 myThing 而不是 MyThing。

稍后添加：

一位评论者询问我的建议以替换大写/小写命名约定。为此，我需要一个具体的例子。假设您有一个简单的 Book 类，它只有一个属性： Title：

public class Book
{
    public string Title { get; private set; }
}

现在您需要一个构造函数。常见的约定是使用属性的小写版本：

public Book(string title)
{
    Title = title;
}

或者，如果您想确保没有歧义：this.Title = title。

人们可以说这在构造函数中是可以的。如果所有的构造函数都这么简单的话，情况可能会是这样。但我的经验是，当构造函数超出几行时，Title 和 title 之间的区别就会消失。当您谈论构造函数以外的方法时，问题会变得更糟。无论哪种方式，您都需要不同的约定。

用什么？我在参数中使用过并看到过各种缩写：例如 ttl。或者像 bookTitle 这样的内容，在使用 Intellisense 时更具描述性。在我看来，这两种方法都比使用仅大小写不同的名称的惯例更好。