软件开发规范：编码规范.pdfVIP

软件开发规范：编码规范--第1页

软件开发规范：编码规范

C#编码规范

目标：

1.安全：代码完成所需的功能之余,不要产生负作用，即要稳定可靠。2.易

读:类、实例、成员变量、成员函数的命名一目了然

3.美观:尽量统一项目组内人员的编程风格。

第一部分：命名

1.命名原则

1)所有的函数（变量/类/文件名）应该代表其实际的作用，应该使用有意义

的单词或

多个词组合，但不要使用人名、项目组名。

2)所有的函数（变量/类名）一律使用英文。

3)使用多个单词时不需要使用连线(如下划线),但对于全部大写的宏需要使

用连

线。

4)多个词组合较长时,可以使用单词的缩写。

5)不得使用非常相近的名字类表示几个不同含义的函数（变量/类）。

6)命名时请考虑名字的唯一性和含义的准确性。

7)使用项目组专用词汇来表达特定的含义(概念),不得把专用词汇挪作他

用。

2.变量的命名

原则:使用匈牙利命名法命名变量

软件开发规范：编码规范--第1页

软件开发规范：编码规范--第2页

1)变量名一般由“类型修饰＋代表变量含意的英文单词或单词缩写”等部分

组成。

类型修饰(小写字母)：

n:int，l:LONG/long，s:short，u:UINT，f:float

b:bool，by:BYTE，ch:char，sz:char[],str:string

2)针对异常捕获过程中的Exception变量命名，在没有冲突的情况下，统一

命名为

e；如果有冲突的情况下，可以重复e，比如：ee。3.函数的命名

1)使用动宾词组表达函数实际所作的事。

2)同名的函数(重载函数)在功能上应该完全相同,在参数上的差别也应一目

了然。

3)不得出现名字非常相近但功能不同的函数.如CreatePage1(),

CreatePage2()等。

4.类命名

1)名字应该能够标识事物的特性。

2)名字尽量不使用缩写，除非它是众所周知的。

3)名字可以有两个或三个单词组成，但通常不应多于三个。

4)在名字中，所有单词第一个字母大写，缩写都要大写。5.控件命名规则5)

不要使用下划线字符(_)。

1)控件命名=Web控件缩写前缀+“_”+变量名

控件LabelTextBoxButtonListBoxDropDownList等等

缩写lb_XXXtb_XXXBtn_XXXLb_XXXDrd_XXXXXXXX

6.文件命名

1)文件起名要有实际意义。

软件开发规范：编码规范--第2页

软件开发规范：编码规范--第3页

2)源文件应尽量使用8.3格式，文件名只能包含字母、数字和下划线，不得

使用其他的

字母。超长的文件名应使用缩写方式减少文件名的长度。建议使用如下的缩写

的规

则（部分情况可以有例外，视具体情况而定）：,缩写一般可以去掉元音字

母以及不发音字母

,单词的首字母一般应该保留。

,当一个单词必须缩成一个字母时，应该选用最有代表性的字母，或首字母。

,多音节的单词可以去掉后面的音节而只保留前面的第一、二音节。