.NET 指南:类型成员的名称
2007-01-28 15:51
246 查看
类型成员包含了下列不同的种类:
方法
属性
字段
事件
这个部分的指导方针有助于类库设计者为与 .NET Frameword 相一致的成员来选择名称。
不要使用与 Get 方法的名称相一致的属性。例如,不要在把属性命名为 EmployeRecord 的同时又把一个方法命名为 GetEmployeRecord。这将导致开发者无法知道到底哪一个成员才是被用来完成他们的编程任务的。
把 Boolean 属性命名为一个肯定性的短语(例如,用 CanSeek 来代替 CantSeek)。另外,你同样可以为 Boolean 属性使用 Is、Can,或 Has 来作为前缀,但是只在它添加值的时候才这样做。考虑给予一个属性以与它的类型相同的名称。在你拥有一个已经被强类型化的枚举属性的时候,属性的名称可以与枚举的名称相同。例如,如果你有一个名为 CacheLevel 的枚举,那么一个返回了它的一个值的属性同样也可以被命名为 CacheLevel。
使用 EventArgs 后缀来命名事件参数类。
在字段名称中使用 Pascal 包装。使用名词或者名词短语来命名字段。不要为字段名称使用前缀。例如,不要使用 g_ 或 s_ 来区别静态或非静态字段。
方法
属性
字段
事件
这个部分的指导方针有助于类库设计者为与 .NET Frameword 相一致的成员来选择名称。
方法的名称
为方法名称指定动词或动词短语。典型的方法都是作用于数据的,所以使用动词来对方法的动作进行描述能够让开发者更加容易地理解到该方法到底做了些什么。在定义通过方法被完成的动作的时候,需要从开发者的观点出发来小心地选择一个清晰的名称。不要选择一个描述方法怎样做以及做了什么的动词;换句话说,就是不要在你的方法名称中使用实现细节。属性的名称
使用名词、名词短语,或者形容词来命名属性。名词短语或者形容词对于属性来说是合适的,因为属性经常被用来保持数据。不要使用与 Get 方法的名称相一致的属性。例如,不要在把属性命名为 EmployeRecord 的同时又把一个方法命名为 GetEmployeRecord。这将导致开发者无法知道到底哪一个成员才是被用来完成他们的编程任务的。
把 Boolean 属性命名为一个肯定性的短语(例如,用 CanSeek 来代替 CantSeek)。另外,你同样可以为 Boolean 属性使用 Is、Can,或 Has 来作为前缀,但是只在它添加值的时候才这样做。考虑给予一个属性以与它的类型相同的名称。在你拥有一个已经被强类型化的枚举属性的时候,属性的名称可以与枚举的名称相同。例如,如果你有一个名为 CacheLevel 的枚举,那么一个返回了它的一个值的属性同样也可以被命名为 CacheLevel。
事件的名称
使用一个动词或者动词短语来命名事件。使用现在式和过去式来给予事件名称以先后的概念。例如,一个在窗口被关闭之前被引发的关闭事件将被命名为 Closing,而一个在窗口被关闭之后被引发的关闭事件则将被命名为 Closed。不要使用 Before 或 After 来作为前缀或后缀来表示先前的和过去的事件。不要使用 EventHandler 后缀来命名事件处理器(与事件类型一样被使用的代理)。在事件处理器的签名中使用两个被命名为 sender 和 e 的参数。参数 sender 的类型应该是 Object,而参数 e 的类型则应该是一个继承自 EventArgs 的实例。使用 EventArgs 后缀来命名事件参数类。
字段的名称
字段的命名指导方针适用于静态、公共,以及被保护的字段。你不能够定义公共或者被保护的实例字段。关于更多信息,请参考:[字段设计]。在字段名称中使用 Pascal 包装。使用名词或者名词短语来命名字段。不要为字段名称使用前缀。例如,不要使用 g_ 或 s_ 来区别静态或非静态字段。
相关文章推荐
- .NET 指南:捕获并且抛出标准的异常类型
- 使用“using”命令后,就可以无障碍地使用名称空间中的各种类型成员。
- .NET 指南:命名空间的名称
- c#新手入门级代码分享 输出枚举类型中所有成员的名称
- .NET 指南:虚拟成员
- .NET 指南:参数的名称
- .NET 指南:成员的重载
- .NET 获取类内成员的名称,以字符串形式显示
- .NET 指南:被装箱的值类型
- .NET中的特殊类型成员
- sqlite数据类型对应的 .NET 数据类型名称
- .NET 指南:资源的名称
- Runtime-遍历类的成员名称和类型
- 特别的 .NET 类型成员
- C#中"错误: 成员名称不能与它们的封闭类型相同"
- 成员名称不能与它们的封闭类型相同
- .NET错误:未找到类型或命名空间名称
- .Net框架下的命名准则--类型成员的名称
- .NET 指南:明确地实现接口的成员
- .NET中的特殊类型成员