软件开发c#编码规范

《软件开发c#编码规范》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、.NET编码规范(仅限内部研发人员）作者:审阅:批准:部门:平台组部门:部门:姓名:姓名:姓名:日期:2008-9-16日期:日期:以下人员协助完成此文档：第132页共132页附录A文档注释变更历史日期版本作者更改说明参考2008-9-16建立第132页共132页附录A文档注释目录第132页共132页附录A文档注释Keywords关键词：Abstract摘要：Listofabbreviations缩略语清单：<对本文所用缩略语进行说明，要求提供每个缩略语的英文全名和中文解释。Describeabbreviationsinthisdocument,fullspelling

2、oftheabbreviationandChineseexplanationshouldbeprovided.>Abbreviations缩略语Fullspelling英文全名Chineseexplanation中文解释第132页共132页附录A文档注释1简介1.1目的本文档面向.NET开发人员，说明.NET设计与开发是需要遵守的约定、惯用法与模式。这些准则用于帮助.NET设计人员理解如何在不同解决方案之间进行权衡。在特殊情况下，要实现好的库设计，可能会需要违反这些设计准则。这类情况应该很少见，所以必须有充分的理由才能作出这种“违反”决定。部分版权所有2005Micro

3、softCorporation。部分版权所有Addison-WesleyCorporation。1.2范围主要包含各.NET开发项目都必须遵循的命名准则、类型设计指南、成员设计指南、扩展性设计、异常设计与使用指南。2命名准则对于组成类库的元素（包括程序集、命名空间、类型、成员和参数），命名准则提供如何为这些元素选择合适的标识符的准则。选择符合这些准则的标识符可以提高您的库的可用性，并使用户相信您的库将不需要学习一组新的规则。为了提供一致的开发人员体验，公共公开的元素（如公共类和受保护的方法）必须遵守这些准则。然而，为在整个代码中保持一致性以及改进可维护性，应考虑在整个代

4、码中始终使用这些约定。2.1大小写约定许多命名约定都与标识符的大小写有关。值得注意的是，公共语言运行库(CLR)支持区分大小写和不区分大小写的语言。本主题中描述的大小写约定可帮助开发人员理解和使用库。第132页共132页附录A文档注释1.1.1大小写样式下列术语描述了标识符的不同大小写形式。1.1.1.1Pascal大小写将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal大小写。例如：BackColor1.1.1.2大小写混合标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如：backColor1.1.1.3大写

5、标识符中的所有字母都大写。例如：IO1.1.2标识符的大小写规则如果标识符由多个单词组成，请不要在各单词之间使用分隔符，如下划线（“_”）或连字符（“-”）等。而应使用大小写来指示每个单词的开头。下列准则是用于标识符的通用规则。1.1.2.1对于由多个单词组成的所有公共成员、类型及命名空间名称，要使用Pascal大小写。注意，这条规则不适用于实例字段。由于成员设计指南中详细说明的原因，不应使用公共实例字段。1.1.2.2对参数名称使用大小写混合。下表汇总了标识符的大小写规则，并提供了不同类型标识符的示例。标识符大小写方式示例类PascalAppDomain枚举类型Pas

6、calErrorLevel枚举值PascalFatalError第132页共132页附录A文档注释事件PascalValueChanged异常类PascalWebException只读的静态字段PascalRedValue接口PascalIDisposable方法PascalToString命名空间PascalSystem.Drawing参数CameltypeName属性PascalBackColor1.1.1首字母缩写词的大小写规则首字母缩写词是由术语或短语中各单词的首字母构成的单词。例如，HTML是HypertextMarkupLanguage的首字母缩写。只有在公

7、众广为认知和理解的情况下，才应在标识符中使用首字母缩写词。首字母缩写词不同于缩写词，因为缩写词是一个单词的缩写。例如，ID是identifier的缩写。通常情况下，库名不应使用缩写词。注意可在标识符中使用的两个缩写词是ID和OK。在采用Pascal大小写格式的标识符中，这两个缩写词的大小写形式应分别为Id和Ok。如果在采用大小写混合格式的标识符中将这两个缩写词用作首个单词，则它们的大小写形式应分别为id和ok。首字母缩写词的大小写取决于首字母缩写词的长度。所有首字母缩写词应至少包含两个字符。为了便于这些准则的实施，如果某一首字母缩写词恰好