类库开发的设计准则结构设计.docVIP

类库开发的设计准则结构设计.NET Framework 开发人员指南类库开发的设计准则 类库开发的设计准则适用于扩展 .NET Framework 并与其交互的库开发。.NET Framework 设计准则的目标旨在通过提供一种独立于开发所用编程语言的统一编程模型，帮助库设计人员确保其用户获得 API 的一致性及易用性的好处。在开发扩展 .NET Framework 的类和组件时，强烈建议您遵循这些设计准则。不一致的库设计会对开发人员的工作效率造成不良影响并妨碍他们互相吸纳。 这些准则用于帮助类库设计人员理解如何在不同解决方案之间进行权衡。在特殊情况下，要实现好的库设计，可能会需要违反这些设计准则。这类情况应该很少见，所以您必须有充分的理由才能作出这种“违反”决定。 对于组成类库的元素（包括程序集、命名空间、类型、成员和参数），命名准则提供如何为这些元素选择合适的标识符的准则。选择符合这些准则的标识符可以提高您的库的可用性，并使用户相信您的库将不需要学习一组新的规则。 为了提供一致的开发人员体验，公共公开的元素（如公共类和受保护的方法）必须遵守这些准则。然而，为在整个代码中保持一致性以及改进可维护性，应考虑在整个代码中始终使用这些约定。 大小写约定 大小写 下列术语描述了标识符的不同大小写形式。 Pascal 将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用 Pascal 大小写。例如： BackColor 标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如： backColor 标识符中的所有字母都大写。例如： IO string strUserName 标识符的大小写规则 下列准则是用于标识符的通用规则。 大小写方式 示例 类 Pascal AppDomain 枚举类型 Pascal ErrorLevel 枚举值 Pascal FatalError 事件 Pascal ValueChanged 异常类 Pascal WebException 只读的静态字段 Pascal RedValue 接口 IPascal IDisposable 方法 Pascal ToString 命名空间 Pascal System.Drawing 参数 camel typeName 属性 Pascal BackColor 中间层方法接口 IPascal ILogin 私有字段 _camel _userName 控件命名 _匈牙利 _txtUserName 局部变量 camel / 匈牙利 textLength / iLength 如果标识符由多个单词组成，请不要在各单词之间使用分隔符，如下划线（“_”）或连字符（“-”）等。而应使用大小写来指示每个单词的开头。 对于由多个单词组成的所有公共成员、类型及命名空间名称，要使用 Pascal 大小写。 对参数名称使用camel大小写混合。 私有字段采用“_camel”大小写混合，以区别参数和缓存参数的私有字段。 对于Class，应避免使用公共字段（const除外），因为C#在数据成员和属性之间做改变会打破二进制兼容性。 控件命名用“_匈牙利”前缀方式。来区分控件和普通变量。 函数中的局部变量则可采用Camel或匈牙利方式。若局部变量是控件形式则采用匈牙利方式。 首字母缩写词的大小写规则 首字母缩写词是由术语或短语中各单词的首字母构成的单词。例如，HTML 是 Hypertext Markup Language 的首字母缩写。只有在公众广为认知和理解的情况下，才应在标识符中使用首字母缩写词。首字母缩写词不同于缩写词，因为缩写词是一个单词的缩写。例如，ID 是 identifier 的缩写。通常情况下，库名不应使用缩写词。 可在标识符中使用的两个缩写词是 ID 和 OK。在采用 Pascal 大小写格式的标识符中，这两个缩写词的大小写形式应分别为 Id 和 Ok。如果在采用大小写混合格式的标识符中将这两个缩写词用作首个单词，则它们的大小写形式应分别为 id 和 ok。 首字母缩写词的大小写取决于首字母缩写词的长度。所有首字母缩写词应至少包含两个字符。为了便于这些准则的实施，如果某一首字母缩写词恰好包含两个字符，则将其视为短型首字母缩写词。包含三个或三个以上字符的首字母缩写词为长型首字母缩写词。 下列准则为短型和长型首字母缩写词指定了正确的大小写规则。标识符大小写规则优先于首字母缩写词大小写规则。 两字符首字母缩写词的两个字符都要大写，但当格式的标识符的首个单词时。 例如，名为 DBRate 的属性是一个采用 Pascal 大小写格式的标识