返回介绍

类、结构和接口的名称

发布于 2025-02-23 23:15:54 字数 3983 浏览 0 评论 0 收藏 0

请按照命名准则适用于常规类型命名。

✓ 执行 命名类和结构与名词或名词短语,使用 PascalCasing。

这将类型名称与方法名称中带有谓词短语区分开来。

✓ 执行 命名接口使用形容词短语或偶尔名词或名词短语。

应该很少使用名词和名词短语,并且它们可能指示该类型应为一个抽象类,并不是接口。

X 不 为前缀 (例如,"C") 的类名。

请考虑 ✓ 结束的名称派生类同名的基类。

这是非常可读,并且清楚地说明关系。 这在代码中的一些示例包括: ArgumentOutOfRangeException ,这是一种类型的 Exception ,和 SerializableAttribute ,这是一种类型的 Attribute 。 但是,务必使用合理的判断,在将应用此原则;例如, Button 类是一种类型的 Control 事件,尽管 Control 未出现在其名称。

✓ 执行 前缀接口名称以字母 I,以指示类型是接口。

例如, IComponent (描述性名词), ICustomAttributeProvider (名词短语),和 IPersistable (形容词) 是适当的接口名称。 与其他类型名称,避免缩写。

✓ 执行 确保的名称不同仅通过"I"前缀的接口名称定义其中类是接口的标准实现的类 – 接口对时。

泛型类型参数的名称

泛型已添加到.NET Framework 2.0。 推出的功能的一种新的标识符称为类型参数

✓ 执行 使用描述性名称 name 泛型类型参数,除非单个字母的名称是完全一目了然,并且描述性的名称将不会增加价值。

请考虑 ✓ 使用 T 作为具有一个单字母类型参数的类型的类型参数名称。

public int IComparer<T> { ... }  
public delegate bool Predicate<T>(T item);  
public struct Nullable<T> where T:struct { ... }  

✓ 执行 前缀描述性类型参数名的 T

public interface ISessionChannel<TSession> where TSession : ISession{  
  TSession Session { get; }  
}  

请考虑 ✓ ,该值指示约束放置在类型参数在参数名。

例如,将参数约束为 ISession 可能调用 TSession

常见类型的名称

✓ 执行 遵循命名类型派生自或实现某些.NET Framework 类型时下表中所述的指南。

基类型派生/实现类型准则
System.Attribute✓ 执行 将后缀"属性"添加到自定义特性类的名称。
System.Delegate✓ 执行 将后缀"EventHandler"添加到的事件中使用的委托的名称。

✓ 执行 添加之外作为事件处理程序使用的后缀"Callback"的名称的委托。

X 不 将后缀"委托"添加到委托。
System.EventArgs✓ 执行 添加后缀"EventArgs。"
System.EnumX 不 从此类派生; 使用改为支持你的语言关键字; 例如,在 C# 中,使用 enum 关键字。

X 不 添加后缀"枚举"或"标志"。
System.Exception✓ 执行 添加后缀"异常"。
IDictionary
IDictionary<TKey,TValue>
✓ 执行 添加后缀"字典。" 请注意, IDictionary 是特定类型的集合,但这一准则将优先于后面的更多常规集合准则。
IEnumerable
ICollection
IList
IEnumerable<T>
ICollection<T>
IList<T>
✓ 执行 添加后缀"集合"。
System.IO.Stream✓ 执行 添加后缀"流"。
CodeAccessPermission IPermission✓ 执行 添加后缀"权限。"

命名枚举

一般情况下 (也称为枚举) 的枚举类型的名称应遵循的标准类型命名规则 (PascalCasing 等)。 但是,有专门适用于枚举的其他指导原则。

✓ 执行 使用枚举的单数形式的类型名称,除非其值是位域。

✓ 执行 使用位域的枚举的复数形式的类型名称将用作值,也称为标志枚举。

X 不 在枚举类型名称中使用"枚举"后缀。

X 不 使用"标志"或"标志"后缀枚举中的键入名称。

X 不 针对多格式文本枚举等使用枚举值名称 (例如,"ad"对 ADO 枚举。)、"rtf"上的前缀。

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

通过从皮尔逊教育版,Inc.的权限重新打印 Framework 设计准则: 约定、 语法和可重用.NET 库,版本 2 的模式 通过 Krzysztof Cwalina 和 Brad Abrams,发布 2008 年 10 月 22,通过 Microsoft Windows 开发系列的一部分的 Addison Wesley Professional。

另请参阅

框架设计指南
命名规则

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。
列表为空,暂无数据
    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文