RNOP产品组开发规范(VS2005 C#)V1.0.docVIP

RNOP产品组开发规范 （VS2005 C#） 2008-9-22目 录 第1章 概述 5 1.1 前言 5 1.2 规范制定原则 5 1.3 术语定义 5 1.3.1 Pascal 大小写 5 1.3.2 Camel 大小写 5 1.4 文件命名组织 5 1.4.1 文件命名 5 1.4.2 文件使用注意 6 第2章 代码外观 7 2.1 开发环境 7 2.2 代码在本机的存放目录 7 2.3 列宽 7 2.4 换行 7 2.5 缩进 7 2.6 空格、括号 - ()、 花括号 - {} 8 第3章 申明 9 3.1 每行声明数 9 3.2 初始化 9 3.3 位置 9 3.4 类和接口的声明 11 3.5 字段的声明 11 第4章 命名规范 12 4.1 命名概述 12 4.2 大小写规则 13 4.3 缩写 14 4.4 命名空间 14 4.5 类 14 4.6 接口 15 4.7 属性 (Attribute) 16 4.8 参数 16 4.9 方法 17 4.10 属性 (property) 17 4.11 常量 (const) 18 4.12 字段 18 第5章 语句 20 5.1 每行一个语句 20 5.2 复合语句 20 5.3 if、 if-else、if else-if 语句 21 5.4 for、foreach 语句 22 5.5 while 语句 22 5.6 do - while 语句 22 5.7 switch - case 语句 23 5.8 try - catch 语句 23 5.9 SQL语句 24 第6章 注释及异常处理 25 6.1 注释 25 6.2 异常处理 26 6.3 调试与编译 28 第7章 数据类型、ADO.NET、控件命名规则 31 7.1 命名方法 31 7.2 数据类型命名规范 31 7.3 ADO.NET 命名规范 31 7.4 主要控件命名规范 32 7.4.1 Standard Control 32 7.4.2 Data Control 33 7.4.3 Validation Control 33 7.4.4 Navigation Control 34 7.4.5 Login Control 34 7.4.6 WebParts Control 34 7.4.7 Developer Express 35 第8章 注意事项 36 8.1 变量名 36 8.2 @ 符号的使用 37 8.3 在DataTable中查询 39 8.4 经验总结 40 第9章 代码管理 42 第10章 公共组件 44 第11章 版本控制 45 概述 前言 为统一RNOP开发人员的编码规范，使程序具有良好的可读性，方便代码的交流和维护，特制定如下编码规定，RNOP全体开发人员需严格遵循本规范进行编码。 规范制定原则 1 方便代码的交流和维护。 2 不影响编码的效率，不与大众习惯冲突。 3 使代码更美观、阅读更方便。 4 使代码的逻辑更清晰、更易于理解。 5 避免重复实现（能使用公共组件尽量使用，如不满足需讨论） 术语定义 Pascal 大小写 将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal 大小写。 例如：BackColor Camel 大小写 标识符的首字母小写，而每个后面连接的单词的首字母都大写。 例如： backColor 文件命名组织 文件命名 1 文件名遵从Pascal命名法，无特殊情况，扩展名小写。 2 使用统一而又通用的文件扩展名： C# 类.cs 文件使用注意 1.? 避免将多个类放在一个文件里面。 2.? 一个文件应该只有一个命名空间，避免将多个命名空间放在同一个文件里面。 3.? 一个文件代码一般控制在300-400行，最好不要超过500行（不包括机器产生的代码）。 代码外观 开发环境 在VS中，为了项目编码规范的一致，RNOP开发人员的VS开发环境需一致（可以把VS开发环境中的编码风格和代码规范设置信息导出为一个配置文件，默认的文件后缀名为.vssettings，其他项目成员则将此文件导入到自己的VS开发环境中即可）。 代码在本机的存放目录 为防止出现因程序代码在不同终端存放在不同目录下导致的编译问题，代码建议存放在本机的D盘相关目录下。具体目录要求如下： 一期功能模块1.0版本：盘符:\RNOP_VSS\RNOP1.0 一期功能模块1.1版本：盘符:\RNOP_VSS\RNOP1.1 公共/用户组件：VSS共享方式 列宽 代码列宽控制在110字符左右。 换行 当表达式超出或即将超出规定的列宽，遵循以下规则进行换行 1、在逗号后换行。 2、在操作符前换行。 3、规则1优先于规则2。 当