C#编程规范 2.0
C#编程规范
Version 2.0
C#编程规范 2.0
目录
第一章 概述............................................................................................................................................4
规范制定原则.......................................................................................................................................4
术语定义...............................................................................................................................................4
Pascal
大小写
...................................................................................................................................4
Camel
大小写
....................................................................................................................................4
文件命名组织.......................................................................................................................................4
1.3.1
文件命名
..................................................................................................................................4
1.3.2
文件注释
..................................................................................................................................4
第二章 代码外观......................................................................................................................................6
2.1 列宽.................................................................................................................................................6
2.2 换行.................................................................................................................................................6
2.3 缩进.................................................................................................................................................6
2.4 空行.................................................................................................................................................6
2.5 空格.................................................................................................................................................6
2.6 括号 - ()...........................................................................................................................................7
2.7 花括号 - {}......................................................................................................................................7
第三章 程序注释......................................................................................................................................9
3.4 注释概述.........................................................................................................................................9
3.2 文档型注释.....................................................................................................................................9
3.3 类 C 注释........................................................................................................................................10
3.4 单行注释.......................................................................................................................................10
3.5 注释标签.......................................................................................................................................10
第四章 申明..........................................................................................................................................14
4.1 每行声明数...................................................................................................................................14
4.2 初始化...........................................................................................................................................14
4.3 位置...............................................................................................................................................14
4.4 类和接口的声明...........................................................................................................................15
4.5 字段的声明...................................................................................................................................15
第五章 命名规范..................................................................................................................................16
5.1 命名概述.......................................................................................................................................16
5.2 大小写规则...................................................................................................................................16
5.3 缩写...............................................................................................................................................17
5.4 命名空间.......................................................................................................................................17
5.5 类...................................................................................................................................................18
5.6 接口...............................................................................................................................................18
5.7 属性 (ATTRIBUTE).........................................................................................................................19
5.8 枚举 (ENUM)..................................................................................................................................19
5.9 参数...............................................................................................................................................19
C#编程规范 2.0
5.10 方法.............................................................................................................................................20
5.11 属性 (PROPERTY).........................................................................................................................20
5.12 事件.............................................................................................................................................21
5.13 常量 (CONST)...............................................................................................................................23
5.14 字段.............................................................................................................................................23
5.15 静态字段.....................................................................................................................................24
5.16 集合.............................................................................................................................................24
5.17 措词.............................................................................................................................................24
第六章 语句..........................................................................................................................................26
6.1 每行一个语句...............................................................................................................................26
6.2 复合语句.......................................................................................................................................26
6.3 RETURN 语句..................................................................................................................................26
6.4 IF、 IF-ELSE、IF ELSE-IF 语句.......................................................................................................26
6.4 FOR、FOREACH 语句.....................................................................................................................27
6.5 WHILE 语句....................................................................................................................................27
6.7. DO - WHILE 语句..........................................................................................................................28
6.8. SWITCH - CASE 语句......................................................................................................................28
6.9. TRY - CATCH 语句.........................................................................................................................28
6.10. USING 块语句..............................................................................................................................29
6.11. GOTO 语句...................................................................................................................................29
第七章 控件命名规则............................................................................................................................30
7.1 命名方法.......................................................................................................................................30
7.2 主要控件名简写对照表...............................................................................................................30
第八章 其他............................................................................................................................................30
8.1 表达式...........................................................................................................................................30
8.2 类型转换.......................................................................................................................................30
附录一: 匈牙利命名法...........................................................................................................................31
C#编程规范 2.0
第一章 概述
规范制定原则
1 方便代码的交流和维护。
2 不影响编码的效率，不与大众习惯冲突。
3 使代码更美观、阅读更方便。
4 使代码的逻辑更清晰、更易于理解。
术语定义
Pascal
大小写
将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用
Pascal 大小写。例如：
BackColor
Camel
大小写
标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如：
backColor
文件命名组织
1.3.1
文件命名
1 文件名遵从 Pascal 命名法，无特殊情况，扩展名小写。
2 使用统一而又通用的文件扩展名： C# 类 .cs
1.3.2
文件注释
1 在每个文件头必须包含以下注释说明
/*----------------------------------------------------------------
// Copyright (C) 2004 东软集团有限公司
// 版权所有。
//
// 文件名：
// 文件功能描述：
//
//
// 创建标识：
//
// 修改标识：
// 修改描述：
//
// 修改标识：
C#编程规范 2.0
// 修改描述：
//----------------------------------------------------------------*/
文件功能描述只需简述，具体详情在类的注释中描述。
创建标识和修改标识由创建或修改人员的拼音或英文名加日期组成。如：
李轶 20040408
一天内有多个修改的只需做一个在注释说明中做一个修改标识就够了。
在所有的代码修改处加上修改标识的注释。
