C#编程规范
1
文档信息
项目编号 项目名称 标题 类别 当前阶段 摘要 当前版本 日期 作者 文档拥有者 送交人员 文件 通用 通用 C#编程规范 规范文档 规划阶段 V1.0 2009-10-5 C#编程规范.doc 文档编号
2
修改历史
日期 版本 作者 修改内容 ” 评审号 更改请求号
3
目录
第一章 概述 .......................................................................................................................................... 6 规范制定原则 ...................................................................................................................................... 6 术语定义 .............................................................................................................................................. 6 Pascal 大小写 ................................................................................................................................. 6 Camel 大小写 ................................................................................................................................. 6 文件命名组织 ...................................................................................................................................... 6 1.3.1文件命名 ................................................................................................................................. 6 1.3.2文件注释 ................................................................................................................................. 6 第二章 代码外观 ................................................................................................................................ 8 2.1 2.2 2.3 2.4 2.5 2.6 2.7
列宽 ......................................................................................................................................... 8 换行 ......................................................................................................................................... 8 缩进 ......................................................................................................................................... 8 空行 ......................................................................................................................................... 8 空格 ......................................................................................................................................... 8 括号 - () ................................................................................................................................... 9 花括号 - {} .............................................................................................................................. 9
第三章 程序注释 .................................................................................................................................. 11 3.4 3.2 3.3 3.4 3.5
注释概述 ............................................................................................................................... 11 文档型注释 ........................................................................................................................... 11 类C注释 ............................................................................................................................... 12 单行注释 ............................................................................................................................... 12 注释标签 ............................................................................................................................... 12
第四章 申明 ........................................................................................................................................ 16 4.1 4.2 4.3 4.4 4.5
每行声明数 ........................................................................................................................... 16 初始化 ................................................................................................................................... 16 位置 ....................................................................................................................................... 16 类和接口的声明 ................................................................................................................... 17 字段的声明 ........................................................................................................................... 17
第五章 命名规范 ................................................................................................................................ 18 5.1 5.2 5.3 5.4 5.5 5.6 5.7 5.8 5.9
命名概述 ............................................................................................................................... 18 大小写规则 ........................................................................................................................... 18 缩写 ....................................................................................................................................... 19 命名空间 ............................................................................................................................... 19 类 ........................................................................................................................................... 19 接口 ....................................................................................................................................... 20 属性 (ATTRIBUTE) ................................................................................................................... 21 枚举 (ENUM) ........................................................................................................................... 21 参数 ....................................................................................................................................... 21
4
5.10 5.11 5.12 5.13 5.14 5.15 5.16 5.17
方法 ................................................................................................................................... 21 属性 (PROPERTY) ................................................................................................................. 22 事件 ................................................................................................................................... 23 常量 (CONST)...................................................................................................................... 24 字段 ................................................................................................................................... 24 静态字段 ........................................................................................................................... 25 集合 ................................................................................................................................... 26 措词 ................................................................................................................................... 26
第六章 语句 ........................................................................................................................................ 27 6.1 6.2 6.3 6.4 6.5 6.7. 6.8. 6.10. 6.11.
每行一个语句 ....................................................................................................................... 27 复合语句 ............................................................................................................................... 27
RETURN 语句 ............................................................................................................................ 27 IF、 IF-ELSE、IF ELSE-IF 语句 ............................................................................................. 27
6.4 FOR、FOREACH 语句.................................................................................................................... 28
WHILE 语句 ........................................................................................................................... 28 DO - WHILE 语句 .................................................................................................................... 29 SWITCH - CASE 语句 .............................................................................................................. 29 USING 块语句...................................................................................................................... 30 GOTO 语句 ........................................................................................................................... 30
6.9. TRY - CATCH 语句 .................................................................................................................... 29
第七章 控件命名规则 ....................................................................................................................... 31 7.1 7.2
命名方法 ............................................................................................................................... 31 主要控件名简写对照表 ....................................................................................................... 31
第八章 其他 ....................................................................................................................................... 31 8.1 8.2
表达式 ................................................................................................................................... 31 类型转换 ............................................................................................................................... 31
附录一: 匈牙利命名法 ......................................................................................................................... 32
5