文档介绍：C#编程规范
Version
目录
第一章概述 4
规范制定原则 4
术语定义 4
Pascal 大小写 4
Camel 大小写 4
文件命名组织 4
4
第二章代码外观 5
列宽 5
换行 5
缩进 5
空行 5
空格 5
括号- () 6
花括号- {} 6
第三章注释规范 8
一般规则 8
文件注释 9
函数注释 9
文档型注释 9
类c注释 10
单行注释 10
注释标签 11
第四章申明 14
每行声明数 14
初始化 14
位置 14
类和接口的声明 15
字段的声明 15
第五章命名规范 16
命名概述 16
大小写规则 16
缩写 17
命名空间 17
类 18
接口 18
属性(Attribute) 19
枚举(Enum) 19
参数 19
方法 20
属性(property) 20
事件 21
常量(const) 22
字段 22
静态字段 23
集合 24
措词 24
第六章语句 25
每行一个语句 25
复合语句 25
return 语句 25
if、 if-else、if else-if 语句 25
for、foreach 语句 26
while 语句 26
. do - while 语句 27
. switch - case 语句 27
. try - catch 语句 27
. using 块语句 28
. goto 语句 28
第七章 控件命名规则 29
命名方法 29
主要控件名简写对照表 29
第八章 其他 29
表达式 29
类型转换 29
附录一: 匈牙利命名法 30
第一章概述
规范制定原则
方便代码的交流和维护。
不影响编码的效率,不与大众习惯冲突。
使代码更美观、阅读更方便。
使代码的逻辑更清晰、更易于理解。
术语定义
Pascal 大小写
将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal 大小写。例如:
BackColor
Camel 大小写
标识符的首字母小写,而每个后面连接的单词的首字母都大写。例如:
backColor
文件命名组织
1 文件名遵从Pascal命名法,无特殊情况,扩展名小写。
2 使用统一而又通用的文件扩展名: C#
第二章代码外观
列宽
代码及注释列宽控制在80字符左右。
换行
当表达式超出或即将超出规定的列宽,遵循以下规则进行换行
1、在逗号后换行。
2、在操作符前换行。
3、规则1优先于规则2。
当以上规则会导致代码混乱的时候自己采取更灵活的换行规则。
缩进
缩进应该是每行一个Tab(4个空格),不要在代码中使用Tab字符。
Visual 设置:工具->选项->文本编辑器->C#->制表符->插入空格
空行
空行是为了将逻辑上相关联的代码分块,以便提高代码的可阅读性。
在以下情况下使用两个空行
1、接口和类的定义之间。
2、枚举和类的定义之间。
3、类与类的定义之间。
在以下情况下使用一个空行
1、方法与方法、属性与属性之间。
2、方法中变量声明与语句之间。
3、方法与方法之间。
4、方法中不同的逻辑块之间。
5、方法中的返回语句与其他的语句之间。
6、属性与方法、属性与字段、方法与字段之间。
7、注释与它注释的语句间不空行,但与其他的语句间空一行。
空格
在以下情况中要使用到空格
1、关键字和左括符“(”应该用空格隔开。如
while (true)
注意在方法名和左括符“(”之间不要使用空格,这样有助于辨认代码中的方法调用与关键字。
多个参数用逗号隔开,每个逗号后都应加一个空格。
除了. 之外,所有的二元操作符都应用空格与它们的操作数隔开。一元操作符、++及--与操作数间不需要空格。如
a += c + d;
a = (a + b