C#编码规范 

  学习了一段时间C#,写了不少代码。颇感代码规范的重要性,现整理收录了一些,仅供参考!

目标

1.安全

代码完成所需的功能之余,不要产生负作用,要稳定可靠.

2.易读

,实例,成员变量,成员方法的命名一目了然

3.美观

尽量统一项目组内人员的编程风格,保证一致性,统一性.

.具体注意事项.

()命名

1.命名原则

(1)所有的方法(变量//文件名)应该代表其实际的作用.应该使用具有意义的单词或多个词组合,但不要使用人名,项目组名.

(2)所有的方法(变量/类名)一律使用英文.

(3)使用多个单词时不需要使用连线(如下划线)

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

(5)不得使用非常相近的名字来表示几个不同含义的方法(变量/).

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

(7)命名采用三种格式,Pascal,Camel,首字母全部大写格式如:ID

2.变量的命名

(1)变量名一般由"前缀+类型修饰+代表变量含意的英文单词或单词缩写"等部分组成.

:

*前缀(以下划线分割):

t_:表示线程的全局变量.:t_nCount

m_:表示类成员变量(包含类表态变量):m_dwFlags

局部变量以”_”开头,如 _userName

*主体使用一个或多个单词表示变量代表的确切含义,参见下面的大小写规则。

*类型修饰(小写字母):

n

l

s

u

f

b

by

ch

sz

str

dou

int

long

short

uint

float

bool

byte

char

char[]

String

double

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

3.方法的命名

(1)使用动宾词组表达方法所做的事.命名采用Pascal形式

如:ShowUserInfo(),BoundGridView()

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

(3)不得出现名字非常相近但功能不符的方法.:CreatePage1(),CreatePage2().

4.类命名

(1)名字应该能够标识事物的特性.Public class Employee()

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

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

(4)在名字中,所有单词第一个字母都大写。缩写都要大写。

(5)不要使用下划线连接符(_).

如:public classs EmployeeComputeSalary 即采用Pascal大小写形式。

5.控件命名规则

控件命名=Web控件缩写前缀+"_"+变量名

控件

Label

TextBox

ListBox

DropDownList

GridView

DataGrid

DataSet

缩写

lbl

tbx

lbx

ddl

gv

dg

ds

控件

Panel

SqlDataSourse

DataList

 

 

 

 

缩写

pnl

sds

dl

 

 

 

 

6.文件命名

(1)文件命名要具有实际意义。

(2)源文件应尽量使用8.3格式,文件名只能包含字母,数字和下划线,不得使用其他的字母,超长的文件名应使用缩写方式减少文件名的长度,建议使用如下的缩写的规则(部分情况可以历例外,视具体情况而定);

*缩写一般可以去掉无意字母以及不发音字母。

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

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

*多音节的单词可以去掉后面的音节而只保留有意义的音节。

*可以使用一些谐音表示一个单词,如2表示to4表示four等等,

(3)当单词数量少,字母少时不需要缩写词。

(4)临时文件必须调用系统函数生成,禁止使用固定文件名,一般情况下,临时文件应在系统临时目录下(通过系统函数取到临时目录名)生成。

7.参数的命名

一般要采用大小写混合格式。如protect bool login(string userName,string userPass)