C#代码规范(简版)
C#项目代码规范
目的
1.方便代码的交流和维护。
2.不影响编码的效率,不与大众习惯冲突。
3.使代码更美观、阅读更方便。
4.使代码的逻辑更清晰、更易于理解。
在C#中通常使用的两种编码方式如下
Camel(驼峰式): 大小写形式-除了第一个单词,所有单词第一个字母大写,其他字母小写。
Pascal(帕斯卡): 大小写形式-所有单词第一个字母大写,其他字母小写。
(经与合作同学讨论,本次采用类似驼峰命名法)
C#代码规范
1、 类型(类、结构、委托、接口)、字段、属性、方法、事件的命名
优先考虑使用英文(尽量使用英文),如果实在没有合适的英文进行描述,可以使用拼音,使用中文是不符合要求的。
2、不使用缩写
所有类型、字段、属性、方法、事件尽量不使用缩写,包括大家熟知的缩写,例如msg。
3、不使用单个字母的变量
不使用单个字母的变量, 像 i、m、n,使用index等来替换,用于循环迭代的变量除外,对于临时变量要有注释说明,除特殊情况均使用temp命名。
4、用Tab作为缩进,并设置缩进大小为4
5、 注释
类型、属性、事件、方法、方法参数,根据需要添加注释。
6、调用类型成员内部其他成员,需加this,调用父类成员需加base