类型成员的名称

类型包含以下几种成员:

  • 方法

  • 属性

  • 字段

  • 事件

本节中的准则有助于类库设计者为成员选择与 .NET Framework 一致的名称。

方法的名称

使用动词或动词短语作为方法的名称。

通常,方法对数据进行操作,因此,使用动词描述方法的操作可使开发人员更易于了解方法所执行的操作。 定义由方法执行的操作时,应从开发人员的角度仔细选择明确的名称。 不要选择描述方法如何执行其操作的动词,也就是说,不要使用实现细节作为方法名称。

属性的名称

使用名词、名词短语或形容词作为属性的名称。

名词短语或形容词适合于属性,因为属性保存数据。

不要使用与 Get 方法同名的属性。

例如,不要将一个属性命名为 EmployeeRecord,又将一个方法命名为 GetEmployeeRecord。 开发人员会不知道使用哪个成员来完成其编程任务。

使用肯定性短语作为布尔值属性的名称(如使用 CanSeek 而不使用 CantSeek)。 此外,还可以为布尔值属性添加前缀(如 Is、Can 或 Has),但要注意使用得当。

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

如果某个属性已强类型化为某个枚举,则该属性可与该枚举同名。 例如,如果有一个名为 CacheLevel 的枚举,则返回其中一个枚举值的属性也可以命名为 CacheLevel。

事件的名称

使用动词或动词短语作为事件的名称。

在为事件命名时,使用现在时或过去时表示时间上的前后概念。 例如,在窗口关闭之前引发的关闭事件可命名为“Closing”,在窗口关闭之后引发的关闭事件可命名为“Closed”。

不要使用“Before”或“After”作为前缀或后缀来指示之前和之后发生的事件。

使用后缀 EventHandler 命名事件处理程序(用作事件类型的委托)。

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

sender 参数的类型应为 Object,e 参数应是 EventArgs 的实例或继承自它。

使用 EventArgs 后缀命名事件参数类。

字段的名称

字段的命名准则适用于静态公共字段和静态受保护字段。 不要定义公共实例字段或受保护实例字段。 有关更多信息,请参见字段设计

在字段名称中使用 Pascal 大小写格式。

使用名词或名词短语作为字段的名称。

不要在字段名称中使用前缀。 例如,不要使用 g_ 或 s_ 来区分静态字段和非静态字段。

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

部分版权所有 Addison-Wesley Corporation。 保留所有权利。

设计指引的详细信息,请参阅"框架设计准则: 公约、 成语和可重复使用的模式。网络图书馆"书 Krzysztof Cwalina 和布拉德 · 艾布拉姆斯,2005年艾迪生 - 韦斯利,发表。

请参见

其他资源

类库开发的设计准则

名称准则