类型成员的名称

注意

此内容根据 Pearson Education, Inc. 许可转载自《框架设计指南：可重用 .NET 库的约定、习语和模式第二版》。 该版本于 2008 年出版，并在此后于第三版对该书进行了全面修订。 此页上的一些信息可能已过时。

类型由以下成员构成：方法、属性、事件、构造函数和字段。 以下各节介绍命名类型成员的准则。

方法的名称

方法是执行操作的方式，设计准则要求方法名称为谓词或谓词短语。 遵循此准则，还有利于区分方法名称与属性和类型名称，后者为名词或形容词性短语。

✓ 用谓词或谓词短语为方法命名。

public class String {
    public int CompareTo(...);
    public string[] Split(...);
    public string Trim();
}

属性的名称

与其他成员不同，应向属性给定名词性短语或形容词性名称。 这是因为属性是指数据，属性的名称应反映这一点。 属性名称总是采用帕斯卡大小写。

✓ 使用名词、名词性短语或形容词为属性命名。

❌请不要拥有与“Get”方法同名的属性，如以下示例所示：

public string TextWriter { get {...} set {...} } public string GetTextWriter(int value) { ... }

此模式通常意味着该属性事实上是一种方法。

✓ 用描述集合中项目的复数短语（而不是使用单数短语后接“List”或“Collection”）为集合属性命名。

✓ 用肯定性短语（CanSeek 而非 CantSeek）为布尔属性命名。 还可选择为布尔属性添加“Is”、“Can”或“Has”，但仅在可带来益处时这么做。

✓ 考虑为属性提供与其类型相同的名称。

例如，以下属性可正确获取和设置名为 Color 的枚举值，因此属性名为 Color：

public enum Color {...}
public class Control {
    public Color Color { get {...} set {...} }
}

事件的名称

事件始终指操作，可以是即将发生的，也可以是已经发生的。 因此，对于方法，事件用谓词命名，并用谓词时态指示引发事件的时间。

✓ 用谓词或谓词短语为事件命名。

示例包括Clicked、Painting 和 DroppedDown。

✓ 使用现在时和过去时，为事件名称赋予之前和之后的概念。

例如，在窗口关闭前引发的关闭事件可命名为 Closing，而在窗口关闭后后引发的关闭事件可命名为 Closed。

❌请不要使用“Before”或“After”前缀或后缀指示发生在事件前后。 请如上所示使用现在时和过去时。

✔️ 为事件处理程序（用作事件类型的委托）添加“EventHandler”后缀，如以下示例中所示：

public delegate void ClickedEventHandler(object sender, ClickedEventArgs e);

✓ 在事件处理程序中使用名为 sender 和 e 的两个参数。

sender 参数表示引发事件的对象。 sender 参数的类型通常是 object，即使可以使用更具体的类型。

✓ 为事件参数类名称添加“EventArgs”后缀。

字段的名称

字段命名准则适用于静态公开字段和受保护的字段。 原则不涉及内部和专用字段，而成员设计准则不允许使用公开字段或受保护的实例字段。

✓ 在字段名称中使用帕斯卡大小写。

✓ 使用名词、名词性短语或形容词为字段命名。

❌ 请不要在字段名称中使用前缀。

例如，请勿使用“g_”或“s_”来指示静态字段。

Portions © 2005, 2009 Microsoft Corporation 版权所有。 保留所有权利。

在 Pearson Education, Inc. 授权下，由 Addison-Wesley Professional 作为 Microsoft Windows 开发系列的一部分再版自 Framework Design Guidelines: Conventions, Idioms, and Patterns for Reusable .NET Libraries, 2nd Edition（Framework 设计准则：可重用 .NET 库的约定、惯例和模式第 2 版），由 Krzysztof Cwalina 和 Brad Abrams 发布于 2008 年 10 月 22 日。

请参阅

• 框架设计指南
• 命名规则