OI-IT-16 软件开发编码规范（C#版）.doc

CCC信息技术有限公司深圳分公司 编码规范（C#版） 编号： OI-IT-16 页码/页数： PAGE 1/35 工作文件 版本 A 修订次数 00 修订人 修订日期 2018-9-1 第 PAGE1 页，总 NUMPAGES35 页 编码规范（C#版） 2018年9月1日起发布实施 CCC信息技术有限公司深圳分公司 编码规范（C#版） 编号： OI-IT-16 页码/页数： PAGE 2/35 工作文件 版本 A 修订次数 00 修订人 修订日期 2018-9-1 文档修订历史 修订版本 修订日期 作者 审核人 批准人 说明 目 录 TOC \o "1-3" \h \z \u 1. 概述 5 1.1 规范制定原则 5 1.2 术语定义 5 Pascal 大小写 5 Camel 大小写 5 1.3 文件命名组织 5 文件命名 5 文件注释 5 2. 代码外观 6 2.1 列宽 6 2.2 换行 6 2.3 缩进 7 2.4 空行 7 2.5 空格 7 2.6 括号 8 2.7 花括号 8 3. 程序注释 10 3.1 注释概述 10 3.2 文档型注释 11 3.3 类c注释 11 3.4 单行注释 12 3.5 注释标签 12 4. 声明 16 4.1 每行声明数 16 4.2 初始化 16 4.3 位置 16 4.4 类和接口的声明 17 4.5 字段的声明 17 5. 命名规范 18 5.1 命名概述 18 5.2 大小写规则 19 5.3 缩写 20 5.4 命名空间 20 5.5 类 21 5.6 接口 21 5.7 特性 (Attribute) 22 5.8 枚举 (Enum) 23 5.9 参数 23 5.10 方法 23 5.11 属性 (property) 24 5.12 事件 25 5.13 常量 (const) 27 5.14 字段 27 5.15 静态字段 29 5.16 集合 29 5.17 措词 29 6. 语句 31 6.1 每行一个语句 31 6.2 复合语句 31 6.3 return 语句 31 6.4 if、 if-else、if else-if 语句 31 6.5 for、foreach 语句 33 6.6 while 语句 33 6.7 do - while 语句 34 6.8 switch - case 语句 34 6.9 try - catch 语句 35 6.10 using 块语句 35 6.11 goto 语句 35 概述 规范制定原则 使代码的逻辑更清晰、更易于理解。 方便代码的交流和维护。 使代码更美观、阅读更方便。 不影响编码的效率，不与大众习惯冲突。 术语定义 Pascal 大小写 将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal 大小写。例如： BackColor Camel 大小写 标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如： backColor 文件命名组织 文件命名 文件名遵从Pascal命名法，无特殊情况，扩展名小写。 类型文件名与类型名称一致。 文件注释 在每个文件头必须包含以下注释说明 /* // Copyright (C) 2010 Asia-Peak // // 文件名： // 文件功能描述： // // 创建标识： // // 修改标识： // 修改描述： // // 修改标识： // 修改描述： //*/ 文件功能描述只需简述，具体详情在类的注释中描述。 创建标识和修改标识由创建或修改人员的拼音或英文名加日期组成。如： Xiaofeng Wang一天内有多个修改的只需做一个在注释说明中做一个修改标识就够了。 在代码修改处加上修改标识的注释。 代码外观 列宽 代码列宽控制在110字符左右。 换行 当表达式超出或即将超出规定的列宽，遵循以下规则进行换行： 在逗号后换行。 在操作符前换行。 规则1优先于规则2。 当以上规则会导致代码混乱的时候可采取更灵活的换行规则。 缩进 缩进应该是每行一个Tab(4个空格)，不要在代码中使用Tab字符。 Visual Studio设置：工具 > 选项 > 文本编辑器 > C# > 制表符 > 插入空格 空行 空行是为了将逻辑上相关联的代码分块，以便提高代码的可阅读性。