C#编码规范
目标:
1. 安全:代码完成所需的功能之余,不要产生负作用,即要稳定可靠。
2. 易读: 类、实例、成员变量、成员函数的命名一目了然
3. 美观: 尽量统一项目组内人员的编程风格。
第一部分:命名
1. 命名原则
1) 所有的函数(变量/类/文件名)应该代表其实际的作用,应该使用有意义的单词
或多个词组合,但不要使用人名、项目组名。
2) 所有的函数(变量/类名)一律使用英文。
3) 使用多个单词时不需要使用连线(如下划线), 但对于全部大写的宏需要使用连线。
4) 多个词组合较长时, 可以使用单词的缩写。
5) 不得使用非常相近的名字类表示几个不同含义的函数(变量/类)。
6) 命名时请考虑名字的唯一性和含义的准确性。
7) 使用项目组专用词汇来表达特定的含义(概念), 不得把专用词汇挪作他用。
2. 变量的命名
原则: 使用匈牙利命名法命名变量
1) 变量名一般由“类型修饰+代表变量含意的英文单词或单词缩写”等部分组成。
类型修饰(小写字母):
n: int,l: LONG/long, s: short,u: UINT,f: !oat
b: bool,by: BYTE,ch: char, sz: char[],str: string
2) 针对异常捕获过程中的 Exception 变量命名,在没有冲突的情况下,统一命名为
e;如果有冲突的情况下,可以重复 e,比如:ee。
3. 函数的命名
1) 使用动宾词组表达函数实际所作的事。
2) 同名的函数(重载函数)在功能上应该完全相同, 在参数上的差别也应一目了然。
3) 不得出现名字非常相近但功能不同的函数. 如 CreatePage1(), CreatePage2()
等。
4. 类命名
1) 名字应该能够标识事物的特性。