C#编程规范V1.0

QL研发文档

C#编程规范

V1.0

分类代理类工具使用

第1页

文档编写更新记录

开始日期 2010-10-15 终止日期 内容 编写者 herodragon 审核者 说明 初稿

分类代理类工具使用

第2页

目

1

录

第一章 概述 ............................................................................................................ 4 1.1 规范制定原则 ................................................................................................. 4

1.1.1 方便代码的交流和维护。 ..................................................................... 4

1.1.2 1.1.3

不影响编码的效率，不与大众习惯冲突。 ............................................. 4 使代码更美观、阅读更方便。 .............................................................. 4

1.1.4 使代码的逻辑更清晰、更易于理解。 .................................................... 4 1.2 术语定义 ........................................................................................................ 4

1.2.1 1.2.2 1.3

1.3.1 1.3.2

2

Pascal 大小写....................................................................................... 4 Camel 大小写 ...................................................................................... 4 文件命名 .............................................................................................. 5 文件注释 .............................................................................................. 5

文件命名组织 ................................................................................................. 5

第二章 代码外观 ................................................................................................... 6 2.1 列宽 ............................................................................................................... 6 2.2 2.3 2.4 2.5 2.6

换行 ............................................................................................................... 6 缩进 ............................................................................................................... 6 空行 ............................................................................................................... 6 空格 ............................................................................................................... 7 括号 - () ......................................................................................................... 7

3

2.7 花括号 - {}..................................................................................................... 8 第三章 程序注释..................................................................................................... 10 3.1 注释概述 ...................................................................................................... 10 3.2 文档型注释 ................................................................................................... 11 3.3 3.4

类c注释....................................................................................................... 11 单行注释 ...................................................................................................... 12

4

3.5 注释标签 ...................................................................................................... 12 第四章 申明 .......................................................................................................... 17 4.1 每行声明数 ................................................................................................... 17 4.2 4.3 4.4 4.5

初始化 .......................................................................................................... 17 位置 ............................................................................................................. 17 类和接口的声明 ............................................................................................ 18 字段的声明 ................................................................................................... 18

5

第五章 命名规范 ................................................................................................... 20 5.1 命名概述 ...................................................................................................... 20 5.2 5.3 5.4 5.5 5.6 5.7 5.8 5.9

大小写规则 ................................................................................................... 20 缩写 ............................................................................................................. 22 命名空间 ...................................................................................................... 22 类 ................................................................................................................. 23 接口 ............................................................................................................. 23 属性 (Attribute) ........................................................................................ 24 枚举 (Enum) ................................................................................................. 24 参数 ............................................................................................................. 25

分类代理类工具使用

第3页

5.10 5.11 5.12 5.13 5.14 5.15 5.16 6

方法 .......................................................................................................... 25 属性 (property)....................................................................................... 26 事件 .......................................................................................................... 27 常量 (const) ............................................................................................ 29 字段 .......................................................................................................... 29 静态字段 ................................................................................................... 30 集合 .......................................................................................................... 31

5.17 措词 .......................................................................................................... 31 第六章 语句 .......................................................................................................... 33 6.1 6.2 6.3 6.4 6.5 6.6 6.7

每行一个语句 ............................................................................................... 33 复合语句 ...................................................................................................... 33 return 语句 ................................................................................................... 33 if、 if-else、if else-if 语句 ............................................................................ 33 for、foreach 语句.......................................................................................... 34 while 语句 .................................................................................................... 35 do - while 语句 ............................................................................................. 35

6.8 switch - case 语句.......................................................................................... 36 6.9 try - catch 语句 ............................................................................................. 36 6.10 using 块语句 ............................................................................................. 37 7

6.11 goto 语句 .................................................................................................. 37 第七章 控件命名规则.............................................................................................. 38 7.1 命名方法 ...................................................................................................... 38 7.2 主要控件名简写对照表 ................................................................................. 38 第八章 其他............................................................................................................ 38 8.1 表达式 .......................................................................................................... 38 8.2 类型转换 ...................................................................................................... 39 附录一: 匈牙利命名法............................................................................................. 40

8

9

分类代理类工具使用

第4页

1 第一章 概述

1.1 规范制定原则

1.1.1

方便代码的交流和维护。

不影响编码的效率，不与大众习惯冲突。 使代码更美观、阅读更方便。 使代码的逻辑更清晰、更易于理解。

1.1.2

1.1.3

1.1.4

1.2 术语定义

1.2.1

Pascal 大小写

将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal 大小写。如：BackColor

1.2.2

Camel 大小写

标识符的首字母小写，而每个后面连接的单词的首字母都大写。如：backColor

百度搜索“77cn”或“免费范文网”即可找到本站免费阅读全部范文。收藏本站方便下次阅读，免费范文网，提供经典小说综合文库C#编程规范V1.0在线全文阅读。