C - #编程规范V1[1].0

济南美视网景科技有限公司

软件开发部

C#语言编程规范

Version 1.0

编 制 者：宗 伟 审 核 者：宗 伟

2008-7-10

C# 编程规范

目录

第一章 概述................................................................................................................4 规范制定原则 ............................................................................................................4 术语定义 ....................................................................................................................4 PASCAL 大小写 .........................................................................................................4 CAMEL 大小写 ...........................................................................................................4 文件命名组织 ............................................................................................................4 1.3.1文件命名 ..........................................................................................................4 1.3.2文件注释 ..........................................................................................................4 第二章 代码外观 .....................................................................................................5 2.1 2.2 2.3 2.4 2.5 2.6 2.7 3.4 3.2 3.3 3.4 3.5

列宽..................................................................................................................5 换行..................................................................................................................5 缩进..................................................................................................................5 空行..................................................................................................................5 空格..................................................................................................................6 括号 - () ...........................................................................................................6 花括号 - {} .......................................................................................................7 注释概述..........................................................................................................8 文档型注释......................................................................................................9 类C注释..........................................................................................................9 单行注释..........................................................................................................9 注释标签....................................................................................................... 10

第三章 程序注释 .........................................................................................................8

第四章 申明............................................................................................................. 14 4.1 4.2 4.3 4.4 4.5

每行声明数................................................................................................... 14 初始化........................................................................................................... 14 位置............................................................................................................... 14 类和接口的声明........................................................................................... 15 字段的声明................................................................................................... 15

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

命名概述....................................................................................................... 16 大小写规则................................................................................................... 16 缩写............................................................................................................... 17 命名空间....................................................................................................... 18 类................................................................................................................... 18 接口............................................................................................................... 19 属性 (ATTRIBUTE) ........................................................................................ 19 枚举 (ENUM) ................................................................................................ 20 参数............................................................................................................... 20

C# 编程规范

5.10 5.11 5.12 5.13 5.14 5.15 5.16 5.17 方法 ........................................................................................................... 20 属性 (PROPERTY) ..................................................................................... 21 事件 ........................................................................................................... 22 常量 (CONST) ............................................................................................ 24 字段 ........................................................................................................... 24 静态字段 ................................................................................................... 25 集合 ........................................................................................................... 25 措词 ........................................................................................................... 25

第六章 语句............................................................................................................. 27 6.1每行一个语句................................................................................................... 27 6.2 复合语句....................................................................................................... 27 6.3 RETURN 语句 ................................................................................................ 27 6.4 IF、 IF-ELSE、IF ELSE-IF 语句 .................................................................... 27 6.5 FOR、FOREACH 语句 ................................................................................... 28 6.6 WHILE 语句 ................................................................................................... 28 6.7 DO - WHILE 语句 ............................................................................................... 29 6.8 SWITCH - CASE 语句 ......................................................................................... 29 6.9 TRY - CATCH 语句 ............................................................................................. 29 6.10 USING 块语句 ................................................................................................. 30 6.11 GOTO 语句...................................................................................................... 30 第七章 控件命名规则............................................................................................... 31 7.1 命名方法....................................................................................................... 31 7.2 主要控件名简写对照表（如何简写）....................................................... 31 第八章 其他............................................................................................................... 31 8.1 表达式........................................................................................................... 31 8.2 类型转换....................................................................................................... 31 附录一: 匈牙利命名法 ............................................................................................. 32 ADO.NET命名规则 .............................................................................................. 32 WINFORM CONTROL 命名规范 .............................................................................. 33 WEBCONTROL 命名规范 ....................................................................................... 34

C# 编程规范

第一章 概述

规范制定原则

1 方便代码的交流和维护。

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

术语定义

Pascal 大小写

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

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

文件命名组织

1.3.1文件命名

1 文件名遵从Pascal命名法，无特殊情况，扩展名小写。 2 使用统一而又通用的文件扩展名： C# 类 .cs 1.3.2文件注释

1 在每个文件头必须包含以下注释说明

/*---------------------------------------------------------------- // Copyright (C) 2008 美视网景科技有限公司 版权所有。 // 文件名：FileName.cs // 文件功能描述： 公共枚举库 // 创建标识：张三 2008-7-10 // 修改标识：李四 2008-7-11 // 修改描述：修正了不能访问的问题 // 修改标识：王五 2008-7-12

// 修改描述：修正了不能提取数据的问题

//----------------------------------------------------------------*/