软件代码编写规范.docx
《软件代码编写规范.docx》由会员分享，可在线阅读，更多相关《软件代码编写规范.docx（29页珍藏版）》请在冰豆网上搜索。
软件代码编写规范
软件代码编写规范
软件代码编写规范
草稿
1命名规则
命名规则
一致的命名模式是托管类库中可预知性与可发现性最重要的元素之一。
对这些命名指南广泛的使用和理解将消除许多最常见的用户问题。
本主题提供.NETFramework类型的命名指南。
对于每个类型，还应该注意关于大写样式、区分大小写和措词的一些通用规则。
1.1.1大写样式
描述用于在类库中命名标识符的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
注意很少使用。
属性优于使用公共实例字段。
1.1.2区分大小写
为了避免混淆和保证跨语言交互操作，请遵循有关区分大小写的使用的下列规则：
不要使用要求区分大小写的名称。
对于区分大小写和不区分大小写的语言，组件都必须完全可以使用。
不区分大小写的语言无法区分同一上下文中仅大小写不同的两个名称。
因此，在创建的组件或类中必须避免这种情况。
不要创建仅是名称大小写有区别的两个命名空间。
例如，不区分大小写的语言无法区分以下两个命名空间声明。
namespace;
namespace;
不要创建具有仅是大小写有区别的参数名称的函数。
下面的示例是不正确的。
voidMyFunction（stringa,stringA）
不要创建具有仅是大小写有区别的类型名称的命名空间。
在下面的示例中，Pointp和POINTp是不适当的类型名称，原因是它们仅在大小写方面有区别。
p
p
不要创建具有仅是大小写有区别的属性名称的类型。
在下面的示例中，intColor和intCOLOR是不适当的属性名称，原因是它们仅在大小写方面有区别。
intColor{get,set}
intCOLOR{get,set}
不要创建具有仅是大小写有区别的方法名称的类型。
在下面的示例中，calculate和Calculate是不适当的方法名称，原因是它们仅在大小写方面有区别。
voidcalculate（）
voidCalculate（）
1.1.3缩写
为了避免混淆和保证跨语言交互操作，请遵循有关区缩写的使用的下列规则：
不要将缩写或缩略形式用作标识符名称的组成部分。
例如，使用GetWindow，而不要使用GetWin。
不要使用计算机领域中未被普遍接受的缩写。
在适当的时候，使用众所周知的缩写替换冗长的词组名称。
例如，用UI作为UserInterface的缩写，用OLAP作为On-lineAnalyticalProcessing的缩写。
在使用缩写时，对于超过两个字符长度的缩写，请使用Pascal大小写或Camel大小写。
例如，使用HtmlButton或htmlButton。
但是，应当大写仅有两个字符的缩写，如，，而不是。
不要在标识符或参数名称中使用缩写。
如果必须使用缩写，对于由多于两个字符所组成的缩写请使用Camel大小写，虽然这和单词的标准缩写相冲突。
1.1.4措词
避免使用与常用的.NETFramework命名空间重复的类名称。
例如，不要将以下任何名称用作类名称：
System、Collections、Forms或UI。
有关.NETFramework命名空间的列表，请参见类库。
另外，避免使用和以下关键字冲突的标识符。
AddHandler
AddressOf
Alias
And
Ansi
As
Assembly
Auto
Base
Boolean
ByRef
Byte
ByVal
Call
Case
Catch
CBool
CByte
CChar
CDate
CDec
CDbl
Char
CInt
Class
CLng
CObj
Const
CShort
CSng
CStr
CType
Date
Decimal
Declare
Default
1.1.5避免类型名称混淆
语言
不同的编程语言使用不同的术语标识基本托管类型。
类库设计人员必须避免使用语言特定的术语。
请遵循本节中描述的规则以避免类型名称混淆。
使用描述类型的含义的名称，而不是描述类型的名称。
如果参数除了其类型之外没有任何语义含义，那么在这种罕见的情况下请使用一般性名称。
例如，支持将各种数据类型写入到流中的类可以有以下方法。
[Visual?
Basic]
SubWrite（valueAsDouble）;
SubWrite（valueAsSingle）;
SubWrite（valueAsLong）;
SubWrite（valueAsInteger）;
SubWrite（valueAsShort）;
[C#]
voidWrite（doublevalue）;
voidWrite（floatvalue）;
voidWrite（longvalue）;
voidWrite（intvalue）;
voidWrite（shortvalue）;
不要创建语言特定的方法名称，如下面的示例所示。
[Visual?
Basic]
SubWrite（doubleValueAsDouble）;
SubWrite（singleValueAsSingle）;
SubWrite（longValueAsLong）;
SubWrite（integerValueAsInteger）;
SubWrite（shortValueAsShort）;
[C#]
voidWrite（doubledoubleValue）;
voidWrite（floatfloatValue）;
voidWrite（longlongValue）;
voidWrite（intintValue）;
voidWrite（shortshortValue）;
如果有必要为每个基本数据类型创建唯一命名的方法，那么在这种极为罕见的情况下请使用通用类型名称。
下表列出基本数据类型名称和它们的通用替换。
C#类型名称
VisualBasic类型名称
JScript类型名称
VisualC++类型名称
表示形式
通用类型名称
sbyte
SByte
sByte
char
int8
SByte
byte
Byte
byte
unsignedchar
unsignedint8
Byte
short
Short
short
short
int16
Int16
ushort
UInt16
ushort
unsignedshort
unsignedint16
UInt16
int
Integer
int
int
int32
Int32
uint
UInt32
uint
unsignedint
unsignedint32
UInt32
long
Long
long
__int64
int64
Int64
ulong
UInt64
ulong
unsigned__int64
unsignedint64
UInt64
float
Single
float
float
float32
Single
double
Double
double
double
float64
Double
bool
Boolean
boolean
bool
bool
Boolean
char
Char
char
wchar_t
char
Char
string
String
string
String
string
String
object
Object
object
Object
object
Object
例如，支持将从流读取各种数据类型的类可以有以下方法。
[Visual?
Basic]
ReadDouble（）AsDouble
ReadSingle（）AsSingle
ReadInt64（）AsLong
ReadInt32（）AsInteger
ReadInt16（）AsShort
[C#]
doubleReadDouble（）;
floatReadSingle（）;
longReadInt64（）;
intReadInt32（）;
shortReadInt16（）;
上面的示例优先于下面的语言特定的替代方法。
[Visual?
Basic]
ReadDouble（）AsDouble
ReadSingle（）AsSingle
ReadLong（）AsLong
ReadInteger（）AsInteger
ReadShort（）AsShort
[C#]
doubleReadDouble（）;
floatReadFloat（）;
longReadLong（）;
intReadInt（）;
shortReadShort（）;
1.1.6命名空间命名指南
命名命名空间时的一般性规则是使用公司名称，后跟技术名称和可选的功能与设计，如下所示。
[.Feature][.Design]
例如：
给命名空间名称加上公司名称或者其他知名商标的前缀可以避免两个已经发布的命名空间名称相同的可能性。
例如，是由Microsoft提供的OfficeAutomationClasses的一个适当的前缀。
在第二级分层名称上使用稳定的、公认的技术名称。
将组织层次架构用作命名空间层次架构的基础。
命名一个命名空间，该命名空间包含为具有.Design后缀的基命名空间提供设计时功能的类型。
例如，命名空间包含用于设计基于的应用程序的设计器和相关的类。
嵌套的命名空间应当在包含它的命名空间中的类型上有依赖项。
例如，中的类依赖于中的类。
但是，中的类不依赖于中的类。
应当对命名空间使用Pascal大小写，并用句点分隔逻辑组件，如中所示。
如果您的商标使用非传统的大小写，请遵循您的商标所定义的大小写，即使它与规定的Pascal大小写相背离。
例如，命名空间和阐释了对于Pascal大小写规则的适当背离。
如果在语义上适当，使用复数命名空间名称。
例如，使用而不是。
此规则的例外是商标名称和缩写。
例如，使用而不是。
不要为命名空间和类使用相同的名称。
例如，不要既提供Debug命名空间也提供Debug类。
最后，请注意命名空间名称不必非得与程序集名称相似。
例如，如果命名程序集，它没有必要非得包含命名空间。
推荐使用的命名空间
1.1.7类命名指南
以下规则概述命名类的指南：
使用名词或名词短语命名类。
使用Pascal大小写。
少用缩写。
不要使用类型前缀，如在类名称上对类使用C前缀。
例如，使用类名称FileStream，而不是CFileStream。
不要使用下划线字符（_）。
有时候需要提供以字母I开始的类名称，虽然该类不是接口。
只要I是作为类名称组成部分的整个单词的第一个字母，这便是适当的。
例如，类名称IdentityStore就是适当的。
在适当的地方，使用复合单词命名派生的类。
派生类名称的第二个部分应当是基类的名称。
例如，ApplicationException对于从名为Exception的类派生的类是适当的名称，原因是ApplicationException是一种Exception。
请在应用该规则时进行合理的判断。
例如，Button对于从Control派生的类是适当的名称。
尽管按钮是一种控件，但是将Control作为类名称的一部分将使名称不必要地加长。
下面是正确命名的类的示例。
[Visual?
Basic]
PublicClassFileStream
PublicClassButton
PublicClassString
[C#]
publicclassFileStream
publicclassButton
publicclassString
1.1.8接口命名指南
以下规则概述接口的命名指南：
用名词或名词短语，或者描述行为的形容词命名接口。
例如，接口名称IComponent使用描述性名词。
接口名称ICustomAttributeProvider使用名词短语。
名称IPersistable使用形容词。
使用Pascal大小写。
少用缩写。
给接口名称加上字母I前缀，以指示该类型为接口。
在定义类/接口对（其中类是接口的标准实现）时使用相似的名称。
两个名称的区别应该只是接口名称上有字母I前缀。
不要使用下划线字符（_）。
以下是正确命名的接口的示例。
[VisualBasic]
PublicInterfaceIServiceProvider
PublicInterfaceIFormatable
[C#]
publicinterfaceIServiceProvider
publicinterfaceIFormatable
以下代码示例阐释如何定义IComponent接口及其标准实现Component类。
[VisualBasic]
PublicInterfaceIComponent
'Implementationcodegoeshere.
EndInterface
PublicClassComponent
ImplementsIComponent
'Implementationcodegoeshere.
EndClass
[C#]
publicinterfaceIComponent
{
}
publicclassComponent:
IComponent
{
}
1.1.9属性命名指南
应该总是将后缀Attribute添加到自定义属性类。
以下是正确命名的属性类的示例。
[Visual?
Basic]
PublicClassObsoleteAttribute
[C#]
publicclassObsoleteAttribute{}
1.1.10枚举类型命名指南
枚举（Enum）值类型从Enum类继承。
以下规则概述枚举的命名指南：
对于Enum类型和值名称使用Pascal大小写。
少用缩写。
不要在Enum类型名称上使用Enum后缀。
对大多数Enum类型使用单数名称，但是对作为位域的Enum类型使用复数名称。
总是将FlagsAttribute添加到位域Enum类型。
1.1.11静态字段命名指南
以下规则概述静态字段的命名指南：
使用名词、名词短语或者名词的缩写命名静态字段。
使用Pascal大小写。
不要在静态字段名称中使用匈牙利语表示法的前缀。
建议尽可能使用静态属性而不是公共静态字段。
1.1.12参数命名指南
必须仔细遵守这些参数的命名指南，这非常重要，因为提供上下文相关帮助和类浏览功能的可视化设计工具会在设计器中对用户显示方法参数名称。
以下规则概述参数的命名指南：
对参数名称使用Camel大小写。
使用描述性参数名称。
参数名称应当具有足够的描述性，以便参数的名称及其类型可用于在大多数情况下确定它的含义。
例如，提供上下文相关帮助的可视化设计工具会按开发人员键入的实际内容显示方法参数。
在这种情况下，方法参数名称的表述必须清楚明白，开发人员才能提供正确的参数。
使用描述参数的含义的名称，而不要使用描述参数的类型的名称。
开发工具将提供有关参数的类型的有意义的信息。
因此，通过描述意义，可以更好地使用参数的名称。
少用基于类型的参数名称，仅在适合使用它们的地方使用它们。
不要使用保留的参数。
保留的参数是专用参数，如果需要，可以在未来的版本中公开它们。
相反，如果在类库的未来版本中需要更多的数据，请为方法添加新的重载。
不要给参数名称加匈牙利语类型表示法的前缀。
以下是正确命名的参数的示例。
[Visual?
Basic]
GetType（typeNameAsString）AsType
Format（formatAsString,args（）Asobject）AsString
[C#]
TypeGetType（stringtypeName）
stringFormat（stringformat,object[]args）
1.1.13方法命名指南
以下规则概述方法的命名指南：
使用动词或动词短语命名方法。
使用Pascal大小写。
以下是正确命名的方法的实例。
RemoveAll（）
GetCharArray（）
Invoke（）
1.1.14属性命名指南
以下规则概述属性的命名指南：
使用名词或名词短语命名属性。
使用Pascal大小写。
不要使用匈牙利语表示法。
考虑用与属性的基础类型相同的名称创建属性。
例如，如果声明名为Color的属性，则属性的类型同样应该是Color。
请参见本主题内下文中的示例。
以下代码示例阐释正确的属性命名。
[Visual?
Basic]
PublicClassSampleClass
PublicPropertyBackColorAsColor
'CodeforGetandSetaccessorsgoeshere.
EndProperty
EndClass
[C#]
publicclassSampleClass
{
publicColorBackColor
{
}
}
以下代码示例阐释提供其名称与类型相同的属性。
[Visual?
Basic]
PublicEnumColor
'InsertcodeforEnumhere.
EndEnum
PublicClassControl
PublicPropertyColorAsColor
Get
'Insertcodehere.
EndGet
Set
'Insertcodehere.
EndSet
EndProperty
EndClass
[C#]
publicenumColor
{
}
publicclassControl
{
publicColorColor
{
get{
set{
}
}
以下代码示例不正确，原因是Color属性是Integer类型的。
[Visual?
Basic]
PublicEnumColor
'InsertcodeforEnumhere.
EndEnum
PublicClassControl
PublicPropertyColorAsInteger
Get
'Insertcodehere.
EndGet
Set
'Insertcodehere.
EndSet
EndProperty
EndClass
[C#]
publicenumColor{
publicclassControl
{
publicintColor
{
get{
set{
}
}
在不正确的示例中，不可能引用Color枚举的成员。
将被解释为访问一个成员，该成员首先获取Color属性（在VisualBasic中为Integer类型，在C#中为int类型）的值，然后再访问该值的某个成员（该成员必须是的实例成员）。
1.1.15事件命名指南
以下规则概述事件的命名指南：
使用Pascal大小写。
不要使用匈牙利语表示法。
对事件处理程序名称使用EventHandler后缀。
指定两个名为sender和e的参数。
sender参数表示引发事件的对象。
sender参数始终是object类型的，即使在可以使用更为特定的类型时也如此。
与事件相关联的状态封装在名为e的事件类的实例中。
对e参数类型使用适当而特定的事件类。
用EventArgs后缀命名事件参数类。
考虑用动词命名事件。
例如，命名正确的事件名称包括Clicked、Painting和DroppedDown。
使用动名词（动词的“ing”形式）创建表示事件前的概念的事件名称，用过去式表示事件后。
例如，可以取消的Close事件应当具有Closing事件和Closed事件。
不要使用BeforeXxx/AfterXxx命名模式。
不要在类型的事件声明上使用前缀或者后缀。
例如，使用Close，而不要使用OnClose。
通常情况下，对于可以在派生类中重写的事件，应在类型上提供一个受保护的方法（称为OnXxx）。
此方法只应具有事件参数e，因为发送方总是类型的实例。
以下示例阐释具有适当名称和参数的事件处理程序。
[Visual?
Basic]
PublicDelegateSubMouseEventHandler（senderAsObject,eAsMouseEventArgs）
[C#]
publicdelegatevoidMouseEve
升级会员 