C# 字段命名指南？

Question

我将自己编写一些 C# 代码，但我想确保遵循最广泛接受的命名约定，以防我想引入其他开发人员、发布我的代码或出售我的代码。现在我遵循微软设定的命名约定，因为它们似乎是最广泛接受的。他们没有提到的一件事是私有字段的命名。在大多数情况下，我看到它们以驼峰命名法命名，就像受保护的字段一样，但这给我带来了一个问题，因为参数名称应该以驼峰命名法命名。以下面的构造函数为例：

public GameItem(string baseName, string prefixName, string suffixName)
{
    //initialize code
}

现在，如果我也对私有字段使用驼峰命名法，则会出现命名冲突，除非我使用“this”来访问类字段（我认为这违反了大多数标准，更不用说意味着更多的打字） 。一种解决方案是为参数提供不同的名称，但为相同的数据提供 2 个不同的名称在逻辑上没有意义。据我所知，C++ 编码中常见的唯一其他解决方案是在开头给私有成员一个下划线 (_camelCase)。该解决方案是否被 C# 编码普遍接受？这个问题还有其他解决方案吗（比如仅使用属性（使用 PascalCase）来访问字段，即使在类本身中也是如此）？

Answer 1

从我所见，字段的 _camelCase 很常见（这是我们在我们的地方和 Microsoft 更喜欢 .NET 运行时）。

我个人使用此标准的理由是，键入 _ 来标识私有字段比 this 更容易。

例如：

void Foo(String a, String b)
{
    _a = a;
    _b = b;
}

与

void Foo(String a, String b)
{
    this.a = a;
    this.b = b;
}

我发现第一个更容易键入和它可以防止我意外地分配给名为 a 的参数，而不是 this.a。
代码分析可维护性规则强化了这一点，其中规定：

• CA1500 变量名称不应与字段名称匹配。

我的另一个原因是 this. 是可选的（Visual Studio / Code 会提示您删除它们），如果它不与局部变量或参数名称冲突，那么就更难知道您正在使用哪个变量。如果您在所有私有字段的开头都有一个 _ ，那么您始终知道哪个是字段以及哪个具有本地范围。

Answer 2

请遵循 Microsoft 命名指南。 字段使用指南表明它应该是驼峰命名法并且没有前缀。请注意，一般规则是没有前缀；具体规则是不使用前缀来区分静态和非静态字段。

不要对字段名称或静态字段名称应用前缀。具体来说，不要对字段名称应用前缀来区分静态字段和非静态字段。例如，应用 g_ 或 s_ 前缀是不正确的。

和（来自一般命名约定）

请勿使用下划线、连字符或任何其他非字母数字字符。

编辑：我会注意到，文档并未具体涉及私有字段，但表明受保护字段应仅采用驼峰命名法。我想您可以从中推断出私有字段的任何约定都是可以接受的。当然，公共静态字段与受保护的静态字段不同（它们是大写的）。我个人的观点是，受保护/私有在范围上没有足够的差异来保证命名约定的差异，特别是当您似乎想要做的就是将它们与参数区分开来时。也就是说，如果您遵循受保护字段的准则，则必须在这方面以与私有字段不同的方式对待它们，以便将它们与参数区分开来。 在引用类中的类成员时，我使用 this 来明确区分。

编辑 2

我已经采用了当前使用的约定作业，即在私有实例变量前添加下划线，并且通常仅使用 PascalCase 将受保护的实例变量公开为属性（通常是自动属性）。这不是我个人的偏好，但我已经习惯了，并且可能会遵循它，直到出现更好的东西。

Answer 3

一般来说，有两种广泛使用的字段命名方式（总是使用驼峰式命名法）：

使用下划线前缀

void F(String someValue) {
  _someValue = someValue;
}

使用 this. 访问字段并避免名称冲突

void F(String someValue) {
  this.someValue = someValue;
}

就我个人而言，我更喜欢后者，但我将使用我工作的组织制定的任何约定。

Answer 4

简短回答：使用_privateField，即对私有字段使用前导下划线。

长答案：这里...

很久以前，微软曾经建议对字段使用camelCase。请参阅此处。请注意该文档的创建时间：2008 年 10 月 22 日。相当古老。

然而，微软最近的代码库描绘了一幅不同的图景。

1. 查看 C# 编码风格 .NET 运行时 GitHub 存储库。 #3 是正在讨论的点。这是相关部分
   <块引用>

   我们对内部和私有字段使用_camelCase，并尽可能使用readonly。

2. 另请查看 Roslyn 存储库的编码风格特别指出它遵循 .NET 运行时的约定。
3. 再看一下 .NET Standard 贡献页面，其中还显示（至少现在）遵循与 .NET CoreFX 相同的指南，它是 . NET 运行时。
4. 在整合之前，CoreCLR 还建议遵循与 CoreFX 相同的指南。
5. 甚至 WinForms 存储库 谈到使用相同的标准。
6. 我想我已经说得够多了。所以，总而言之，如果你想遵循微软建议的指南，我想你知道该怎么做；对私有字段使用前导下划线，如下所示：_privateField。

我的观点：我个人也更喜欢在我的私有字段中使用前导下划线 - 使其非常容易区分，而不需要this。

Answer 5

在我们的商店中，我们使用 Microsoft 建议的私有成员指南开始了我们的第一个 C# 项目，即

camelCaseFieldName

但是我们很快就在私有成员和参数之间遇到了混淆，并切换到

_camelCaseFieldName

对我们来说效果更好的方法。

私有成员通常具有在方法调用之外持续存在的状态 - 前导下划线往往会提醒您这一点。

另请注意，对属性使用 AutoVariable 语法可以最大限度地减少对私有支持字段的需求，即，

public int PascalCaseFieldName { get; set;}

对于（大部分）遵循 MS 指南的一组简洁的标准，请查看 net-naming-conventions-and-programming-standards---最佳实践

Answer 6

正如前面提到的，Microsoft 命名指南 不涵盖私有字段和局部变量命名。而且你在微软内部找不到一致性。如果您在 Visual Studio 中生成类或一次性模式，它将创建类似

public MyClass(int value)
{
    this.value = value;
}

或

private bool disposedValue = false; // To detect redundant calls

protected virtual void Dispose(bool disposing)
{
    if (!disposedValue)
    {
        ...
    }
}

幸运的是，微软开放了越来越多的代码，所以让我们看一下他们的存储库，例如 ASP.NET Core MVC

private readonly IControllerActivator _controllerActivator;
private readonly IControllerPropertyActivator[] _propertyActivators;

或 .NET Core

private T[] _array;

你可能会说，这不是实际上是微软，而是.NET Foundation。公平地说，让我们看一下 Microsoft 存储库< /a>：

private readonly MetricSeries zeroDimSeries;

但这里是 MVC 的古老 Microsoft 实现

private IActionInvoker _actionInvoker;

因此，没有任何关于私有字段命名的常见做法或官方指南。只需选择您喜欢的一项并坚持下去即可。

Answer 7

最重要的是选择一个标准并坚持下去。查看 iDesign 的 C# 编码标准，网址为 IDesign（右侧的链接）。这是一份很棒的文档，涵盖了命名指南等内容。他们建议对局部变量和方法参数使用驼峰式大小写。

Answer 8

我们使用 StyleCop 来强制整个过程的一致性我们的代码。 StyleCop 在 Microsoft 中使用< /a> 针对 C# 源代码的布局、可读性、可维护性和文档实施一组通用的最佳实践。

您可以在构建时运行 StyleCop 并让它生成样式违规警告。

要回答您的具体问题，私有字段应采用驼峰命名法并以“this”为前缀。

Answer 9

我用来区分私有类变量和方法参数的约定是：

private string baseName;
private string prefixName;
private string suffixName;

public GameItem(string baseName, string prefixName, string suffixName)
{
    this.baseName = baseName;
    this.prefixName = prefixName;
    this.suffixName = suffixName;
}

Answer 10

飞利浦 Healtcare C# 编码标准

href="http://www.google. com.tr/url?sa=t&source=web&cd=4&ved=0CBcQFjAD&url=http%3A%2F%2Fblogs.msdn.com%2Fb%2Fericgu%2Farchive%2F2004%2F01%2F19%2F60315。 aspx&ei=XTczTIrHNsyKONftncYB&usg=AFQjCNGXM7B2qGhAakzPmxb44u9_6vpnhA&sig2=G3Qwi_e86d646VYk5i_EWg" rel="nofollow noreferrer">MSDN - Eric Gunnerson

编辑：我使用“this”关键字访问非静态成员C# 和 Java。

Answer 11

遵循 Microsoft 的命名约定，私有字段应使用下划线作为前缀。

例如：

private int _myValue;

祝你好运！

Answer 12

我也对此有疑问，然后我决定查看微软的github代码。我看过的几乎每个源代码都有下划线用于私有字段。

https://learn.microsoft.com/en-us/dotnet /standard/design-guidelines/ 文件似乎没有提到这种用法。

Answer 13

看看 ReSharper。它将在您的姓名与普通准则不符的所有地方下划线，并且您可以对其进行自定义。另外，当然还有大量其他生产力增强措施。

Answer 14

我这样做；与MSDN 基本一致。

class MyClass : MyBaseClass, IMyInterface
{
    public event EventHandler MyEvent;
    int m_MyField = 1;
    int MyProperty {
        get {
            return m_MyField;
        }
        set {
            m_MyField = value;
        }
    }

    void MyMethod(int myParameter) {
        int _MyLocalVaraible = myParameter;
        MyProperty = _MyLocalVaraible;
        MyEvent(this, EventArgs.Empty);
    }
}

这里有更多细节：
http://jerrytech.blogspot.com/2009/09/simple -c-命名约定.html

Answer 15

我用 VB 做的事情比用 C# 做的多得多，所以我想我将一些做法（偏见？）从前者转移到了后者。

我喜欢属性的私有字段有一个前导下划线 - 特别是在 C# 中，因为区分大小写（无论如何，谁的想法是那个？）并且我在模块/类范围的变量前面加上“m” ”并加强其范围。

如果你不喜欢这样，你真的不会喜欢这样：我通常也使用类型前缀（属性字段除外） - “o”代表对象，“s”代表字符串， “i”代表整数等。

我无法用同行评审的论文或任何东西来真正捍卫这一点，但它对我们有用，意味着我们不会因大小写或字段/参数混淆而绊倒。

所以 ...

Class MyClass

    Private msClassVariable  As String = ""

    Private _classProperty As Integer = 0
    Property Readonly ClassProperty() As Integer
        Get
            Return _classProperty
        End Get
    End Property

    Sub New()

        Dim bLocalVariable As Boolean = False
        if _classProperty < 0 Then _classProperty = 0
        msClassVariable  = _classProperty.ToString()
        bLocalVariable = _classProperty > 0
    End Sub

End Class

Answer 16

就我个人而言，我通过前缀“the”来修改参数名称，例如 theSamplingRate。对我来说，这很有意义:)

Answer 17

private string baseName; 
private string prefixName; 
private string suffixName; 

public GameItem(string _baseName, string _prefixName, string _suffixName) 
{ 
    this.baseName = _baseName; 
    this.prefixName = _prefixName; 
    this.suffixName = _suffixName; 
}