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)在名字中，所有单词第一个字母都大写。缩写都要大写。
