编程代码管理规范.docVIP

OnSite.T.S管理规范 V6 PAGE 6/ NUMPAGES 7 编程代码管理规范- V6 TOC \o 1-3 \h \z \u HYPERLINK \l _Toc 一、必要遵循的规范要求 PAGEREF _Toc \h 2 HYPERLINK \l _Toc （一）系统结构 PAGEREF _Toc \h 2 HYPERLINK \l _Toc （二）编码规范 PAGEREF _Toc \h 4 HYPERLINK \l _Toc ? C# PAGEREF _Toc \h 4 HYPERLINK \l _Toc ? SQL数据库 PAGEREF _Toc \h 5 项目代号 编程代码管理规范 文档编号 OS-SYS-M-001-04 修订日期 200 版 本 号 5 编 制 欧国伟 审 核 欧国伟 修订记录 版本号 日期 主要作者 版本描述 1.0 2006 欧国伟 初始版本 2.0 2007年 欧国伟 第二次修正版本 3.0 2007年 欧国伟 第三次修正版本 4.0 2007年 欧国伟 第四次修正版本 5.0 2008 欧国伟 第五次修正版本 5.1 20 欧国伟 第6次修正版本 6 20 欧国伟 第7次修正版本  一、必要遵循的规范要求 （一）系统结构 每个功能模块必须采用分层方式管理代码结构 各层之间的对象的调用规则 只能单向、往下调用，即UI层只能调用BLL层的类和对象，BLL层只能通过DAL层调用DB资源 只能单层调用，即UI层只能调用BLL层的对象，才能访问到DAL层的内容，而不能直接调用DAL层对象。 Info对象可以独立存在，但是，UI层不能直接生成独立的Info，而只能由BLL生成。 Info层 Info对象包括两类：（单记录，集合）。目前大部分业务类都是从DataRow，DataTable中继承的 Info对象一般对应数据库中的数据表（1个或多个），其主要的作用是与DB资源进行交互操作。 Info层中单记录对象：类似DataRow的概念。他的方法基本很少。基本都是被调用的，以获取属性。一般常有的方法包括 对象赋值，取值 对象是否相等-比较 类型转换 基本的属性值正确性的验证 Info层中多记录对象：类似Table的概念，一般的方法包括： 集合元素的增、减、查找； 元素类型转换。 集合概念的正确性验证； Info对象本身的操作，目前基本不允许Info有自己的自定义方法。 UI层 1。要尽可能少代码，尽可能轻量级。 2。所有业务逻辑尽量全部放置在BLL层，而不要放在UI层。这样可以保持编程的弹性。 3。UI层包括的功能： UI层应该只放置基本的界面操作的内容，响应用户操作 管理控件的显示； Info 的赋值、取值； 其他参数的赋值、取值； 显示Info在赋值与取值时的验证提示； 显示BLL执行方法后的验证提示 4．UI层不能直接操作DAL层或直接操作DB资源 5。UI中的资料内容，应该都是取自BLL层中的Info的。对Info的操作，除了基本赋值操作外，都要通过BLL对象完成。 BLL层 。BLL层应该集中处理除了数据访问逻辑以外的所有的业务逻辑。包括的内容： 业务逻辑体类 通用工具 DAL层 所有对数据库的操作，都应该由DAL层执行。 DAL的一个类，应该对应BLL层的一个业务类； DAL的一个方法，应该对应数据库中的一个存储过程。 传递给DAL层的参数，要么是简单的，要么是Info层定义的对象 DAL应该包括的操作有： 分解传入参数值，根据不同参数，调用不同的存储过程； 把存储过程返回值传回上层； DB资源层 泛指所有系统资源，包括远程数据库、本地数据表、资源文件、配置文件等 对于数据库来说，数据处理的逻辑基本上都集中在数据库中处理。  （二）编码规范 C# 所有变量都要按照先定义，后使用的顺序使用。 对于不同类型的变量、常量、模块、过程、类等，使用有意义的名字可以增强程序的可读性。 对于英文项目：所有名字都以英文单词为基础，而不要以拼音。 对于中文项目：所有名字都以中文为基础，建议在中文名的最开始部分是英文或符号。 命名规范 类名使用Pascal 大小写形式 　　public class HelloWorld{ ...}　　 方法使用Pascal 大小写形式 　　public class HelloWorld { void SayHello(string name) { ... }}　　 属性使用Pascal 大小写形式 public class HelloWorld { public DataTable TableGrpTracerWeekly { get { r