2021年软件代码编写规范.doc

文档介绍：软件代码编写规范
初稿
.2
1 命名规则

一致命名模式是托管类库中可预知性和可发觉性最关键元素之一。对这些命名指南广泛使用和了解将消除很多最常见用户问题。本专题提供 .NET Framework 类型命名指南。对于每个类型，还应该注意相关大写样式、区分大小写和措词部分通用规则。

描述用于在类库中命名标识符 Pascal 大小写、Camel 大小写和全部大写样式。
使用下面三种大写标识符约定。
Pascal 大小写
将标识符首字母和后面连接每个单词首字母全部大写。能够对三字符或更多字符标识符使用 Pascal 大小写。比如：
BackColor
Camel 大小写
标识符首字母小写，而每个后面连接单词首字母全部大写。比如：
backColor
大写
标识符中全部字母全部大写。仅对于由两个或更少字母组成标识符使用该约定。比如：


可能还必需大写标识符以维持和现有非托管符号方案兼容性，在该方案中全部大写字母常常见于枚举和常数值。通常情况下，在使用它们程序集之外这些字符应该是不可见。
下表汇总了大写规则，并提供了不一样类型标识符示例。
标识符
大小写
示例
类
Pascal
AppDomain
枚举类型
Pascal
ErrorLevel
枚举值
Pascal
FatalError
事件
Pascal
ValueChange
异常类
Pascal
WebException
注意   总是以 Exception 后缀结尾。
只读静态字段
Pascal
RedValue
接口
Pascal
IDisposable
注意   总是以 I 前缀开始。
方法
Pascal
ToString
命名空间
Pascal

参数
Camel
typeName
属性
Pascal
BackColor
受保护实例字段
Camel
redValue
注意   极少使用。属性优于使用受保护实例字段。
公共实例字段
Pascal
RedValue
注意   极少使用。属性优于使用公共实例字段。

为了避免混淆和确保跨语言交互操作，请遵照相关区分大小写使用下列规则：
不要使用要求区分大小写名称。对于区分大小写和不区分大小写语言，组件全部必需完全能够使用。不区分大小写语言无法区分同一上下文中仅大小写不一样两个名称。所以，在创建组件或类中必需避免这种情况。
不要创建仅是名称大小写有区分两个命名空间。比如，不区分大小写语言无法区分以下两个命名空间申明。
namespace ;
namespace ;
不要创建含有仅是大小写有区分参数名称函数。下面示例是不正确。
void MyFunction(string a, string A)
不要创建含有仅是大小写有区分类型名称命名空间。在下面示例中，Point p 和 POINT p 是不合适类型名称，原因是它们仅在大小写方面有区分。
p
p
不要创建含有仅是大小写有区分属性名称类型。在下面示例中，int Color 和 int COLOR 是不合适属性名称，原因是它们仅在大小写方面有区分。
int Color {get, set}
int COLOR {get, set}
不要创建含有仅是大小写有区分方法名称类型。在下面示例中，calculate 和 Calculate 是不合适方法名称，原因是它们仅在大小写方面有区分。
void calculate()
void Calculate()

为了避免混淆和确保跨语言交互操作，请遵照相关区缩写使用下列规则：
不要将缩写或缩略形式用作标识符名称组成部分。比如，使用 GetWindow，而不要使用 GetWin。
不要使用计算机领域中未被普遍接收缩写。
在合适时候，使用众所周知缩写替换冗长词组名称。比如，用 UI 作为 User Interface 缩写，用 OLAP 作为 On-line Analytical Processing 缩写。
在使用缩写时，对于超出两个字符长度缩写，请使用 Pascal 大小写或 Camel 大小写。比如，使用 HtmlButton 或 htmlButton。不过，应该大写仅有两个字符缩写，如，Sys