属性中使用的变量是否有任何 C# 命名约定？

Question

假设我们有一个变量，我们想将其命名为Fubar

假设Fubar是一个String ！

这意味着，我们会这样定义 Fubar：

public string Fubar;

现在，假设我们希望Fubar有一个 getter 和 setter（或者换句话说，成为一个 C# 属性）！

private string Fubar;
public string Fubar_gs
{
    get
    {
        //Some fancy logic
        return Fubar;
    }
    set
    {
        //Some more fancy logic
        Fubar = value;
    }
}

太好了！ 这一切都很好，很花哨，除了，如果我希望属性被命名为 Fubar，而不是原始变量怎么办？

显然，我只会重命名这两个变量。 但问题是，原始变量的最佳名称是什么？

这种情况有命名约定吗？

Answer 1

根据Microsoft 的命名约定，正确的方法是：

private string fubar;
public string Fubar { get { return fubar; } set { fubar = value; } }

然而，许多人更喜欢在私有字段前面加上下划线，以帮助最大限度地减少在他们打算使用该属性时错误地使用该字段的可能性，反之亦然。

因此，通常会看到：

private string _fubar;
public string Fubar { get { return _fubar; } set { _fubar = value; } }

您采取的方法最终取决于您。 StyleCop 将默认强制执行前者，而 ReSharper 将强制执行后者。

在 C# 6 中，有用于声明属性的默认值或设置只读属性的新语法，从而减少了对具有在get和set方法中没有任何特殊附加逻辑的支持字段的属性的需求。 你可以简单地写：

public string Fubar { get; set; } = "Default Value";

要么

public string Fubar { get; } = "Read-only Value";

Answer 2

用下划线_fubar前缀私有

作为一个很好的指南，您可以使用 CLR 运行时团队编码风格指南，它超越了 Microsoft 的标准命名指南

https://github.com/dotnet/runtime/blob/main/docs/coding-guidelines/coding-style.md

Answer 3

如果您以小写开头命名私有变量，您可以右键单击它们并让 VS 为您生成 getter/setter 代码；

重构->封装字段...

它将使用 Caps 命名该属性。

Answer 4

如果 getter/setter 中没有逻辑，请使用自动属性：

public string Fubar {get; set;}

http://msdn.microsoft.com/en-us/library/bb384054.aspx

Answer 5

不幸的是，没有通用的约定，您必须选择最适合您的情况，我已经在不同的代码库中看到了以下所有方法。

方法一

private string _fubar;   //_camelCase
public string Fubar { ... }

方法二

private string fubar;    //camelCase
public string Fubar{ ... }

方法三

private string _Fubar;    //_PascalCase
public string Fubar{ ... }

还有一些框架需要很多创造力，例如使用属性并将其记录为成员变量，从而使用成员的样式而不是属性的样式（是的 Unity！我指着你和你的MonoBehaviour.transform的属性/成员）

为了消除我们的代码库中的歧义，我们使用我们自制的规则：

• 尝试使用更合适的命名，通常在公共属性中使用的成员与公共属性的用途略有不同，因此大多数情况下很有可能找到不同的专有名称，如果不可能，其目的只是保持状态对于公共财产，为什么不将其命名为nameValue呢？
• 如果可能，使用自动属性

使用我们的方法大多数时候，我们避免了对下划线“_”的怀疑，同时拥有更易读的代码。

private string fubarValue; //different name. Make sense 99% of times
public string Fubar { ... } 

Answer 6

好吧， 框架设计指南文档声明如下：

字段名称 字段命名准则适用于静态公共和受保护字段。 内部和私有字段未包含在指南中，并且成员设计指南中不允许使用公共或受保护的实例字段。

✓ 务必在字段名称中使用 PascalCasing。

✓ 务必使用名词、名词短语或形容词命名字段。

X 不要为字段名称使用前缀。

例如，不要使用“g_”或“s_”来表示静态字段。

所以，对于私有领域，没有官方推荐。 但是，如果您在属性上使用 VS 2017 快速操作“转换为完整属性”，则会发生这种情况：

因此，似乎可以安全地假设在私有字段前面加上下划线是有点标准的。

Answer 7

C#的方式是

private string _fubar;
public string Fubar
{
    get
    {
        return _fubar;
    }
    set
    {
        _fubar = value;
    }
}

但是，如果它只是一个没有额外逻辑的基本 getter/setter，你可以只写

public string Fubar { get; set; }

不需要支持变量或任何东西。

Answer 8

编码标准的好处是有很多可供选择：

• http://www.google.com/search?q=c%23+coding+standards
• http://blogs.msdn.com/b/ericgu/archive/2004/01/19/60315.aspx
• http://www.amazedsaint.com/2010/11/top-6-coding-standards-guideline.html

选择适合您的约定并始终如一地使用它。

Microsoft 约定 - pascalCase 私有字段和 CamelCase 属性是整洁的，但可能会因拼写错误而导致错误。 我发现前导下划线约定很烦人，因为每次键入名称时它都需要额外的两次击键，但您不会得到太多的拼写错误（或者至少编译器首先捕获它们）。

Answer 9

我想，一个名字更好：

public string Fubar { get; private set; }

Answer 10

使用默认值声明的另一种方式

    private string _fubar = "Default Value";
    public string Fubar
    {
        get { return _fubar; }
        set { _fubar = value; }
    }

Answer 11

虽然大多数开发人员遵循 Microsoft 的准则，但作为游戏开发人员，我们遵循 Unity 的风格（ 此处的脚本源代码之一）：

static protected Material s_DefaultText = null;
protected bool m_DisableFontTextureRebuiltCallback = false;
public TextGenerator cachedTextGenerator { ... }

Answer 12

我看到了大量过时的答案（以及代表 C#6 的非标准方式），所以这是 2020 年的答案：

// "fubar" works, too, but "_" prevents CaSe typo mistakes
private string _fubar;
public string Fubar
{
    get => _fubar;
    set => _fubar = value;
}

// Read-only can just use lambda to skip all those shenannigans
public string ReadOnlyFoo => "This is read-only!";