软件代码编写规范.doc

文档介绍：软件代码编写规范
软件代码编写规范
1/23
软件代码编写规范
精品文档
软件代码编写规范
建具有仅是大小写有区别的属性名称的类型。在下面的示例中，intColor和intCOLOR是不适当的属
性名称，原因是它们仅在大小写方面有区别。
intColor{get,set}
intCOLOR{get,set}
不要创建具有仅是大小写有区别的方法名称的类型。在下面的示例中，calculate和Calculate是不适当的方
法名称，原因是它们仅在大小写方面有区别。
voidcalculate( )
voidCalculate( )
缩写
为了避免混淆和保证跨语言交互操作，请遵循有关区缩写的使用的下列规则：
不要将缩写或缩略形式用作标识符名称的组成部分。例如，使用GetWindow，而不要使用GetWin。
不要使用计算机领域中未被普遍接受的缩写。
在适当的时候，使用众所周知的缩写替换冗长的词组名称。例如，用UI作为UserInterface的缩写，用OLAP
作为On-lineAnalyticalProcessing的缩写。
在使用缩写时，对于超过两个字符长度的缩写，请使用Pascal大小写或Camel大小写。例如，使用HtmlButton
或htmlButton。但是，应当大写仅有两个字符的缩写，如，，。
不要在标识符或参数名称中使用缩写。如果必须使用缩写，对于由多于两个字符所组成的缩写请使用Camel大
小写，虽然这和单词的标准缩写相冲突。
软件代码编写规范
软件代码编写规范
5/23
软件代码编写规范
.
软件代码编写规范
软件代码编写规范
23/23
软件代码编写规范
精品文档
措词

命名空间重复的类名称。例如，不要将以下任何名称用作类名称：
System、
Collections
、Forms
或UI。
命名空间的列表，请参见类库。
另外，避免使用和以下关键字冲突的标识符。
AddHandlerAddressOf
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
避免类型名称混淆
语言
不同的编程语言使用不同的术语标识基本托管类型。类库设计人员必须避免使用语言特定的术语。请遵循本节中描述的
规则以避免类型名称混淆。
使用描述类型的含义的名称，而不是描述类型的名称。如果参数除了其类型之外没有任何语义含义，那么在这种罕见的
情况下请使用一般性名称。例如，支持将各种数据类型写入到流中的类可以有以下方法。
[VisualBasic]
SubWrite(valueAsDouble);
SubWrite(valueAsSingle);
SubWrite(valueAsLong);
SubWrite(valueAsInteger);
SubWrite(valueAsShort);
[C#]
voidWrite(doublevalue);
voidWrite(floatvalue);
voidWrite(longvalue);
voidWrite(intvalue);
voidWrite(shortvalue);
不要创建语言特定的方法名称，如下面的示例所示。
[VisualBasic]
SubWrite(doubleValueAsDouble);
SubWrite(singleValueAsSingle);
SubWrite(longValueAsLong);
SubWrite(integerValueAsInteger