大网数据广告活动
.NET 与 C# 开发

类型成员的名称

· 52CE 我爱测

类型的成员包括:方法、属性、事件、构造函数和字段。 以下各部分介绍各类型成员的命名准则。

类型的成员包括:方法、属性、事件、构造函数和字段。 以下各部分介绍各类型成员的命名准则。

方法的名称

由于方法是操作执行的途径,所以设计准则要求方法名称是谓词或谓词短语。 通过遵循这一准则,还可将方法名称与属性和类型名称(即名词或形容词短语)区分开来。

✓ 务必使用谓词或谓词短语作为方法名称。

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

属性的名称

与其他成员不同,属性名称须为名词短语或形容词。 这是因为属性引用数据,且属性名称反映了这一点。 应始终为属性名称使用 PascalCasing。

✓ 务必使用名词、名词短语或形容词来命名属性。

X 不要设立与 "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。

X 请勿使用 “Before” 或 “After” 前缀和后缀来指示事件之前或之后。 应按前述使用现在时态和过去时态。

✓ 请使用 “EventHandler” 后缀来命名事件处理程序(用作事件类型的委托),如以下示例所示:

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

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

sender 参数表示引发事件的对象。 sender 参数的类型通常是 object,且可能会使用更具体的类型。

✓ 务必使用“EventArgs”后缀来命名事件参数类。

字段的名称

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

✓ 请在字段名称中使用 PascalCasing。

✓ 请使用名词、名词短语或形容词来命名字段。

X 请勿在字段名称中使用前缀。

例如,不要使用 "g_" 或 "s_" 来指示静态字段。

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

经 Pearson Education, Inc 授权,转载自框架设计准则:可重用的 .NET 库的约定、习惯用语和模式,第 2 版 作者:Krzysztof Cwalina 和 Brad Abrams,由 Addison Wesley Professional 于 2008 年 10 月 22 日印发,作为 Microsoft Windows 开发系列的一部分。

请参阅

历史资料。此文对应 2019-08-18 的中文文档快照,适用产品版本和命令行为以原文为准。

来源与署名:Microsoft 和文档贡献者(原始作者元数据 KrzysztofCwalina)。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站将 Markdown 转为 HTML,规范化链接,移除外部媒体和导航标记。

资料来源与适用范围

资料来源
Microsoft / .NET 中文文档历史快照
适用范围
历史中文快照 2019-08-18;详见原文产品版本;文档日期 10/22/2008
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-16
授权说明
CC BY 4.0(文档)/ MIT(示例代码)

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。