编程代码管理规范.doc

《编程代码管理规范.doc》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、编程代码管理规范-V6一、必要遵循的规范要求2（一）系统结构2（二）编码规范4uC#4uSQL数据库5项目代号编程代码管理规范文档编号OS-SYS-M-001-04修订日期2008年12月6日版本号5编制欧国伟审核欧国伟修订记录版本号日期主要作者版本描述1.02006年12月31日欧国伟初始版本2.02007年1月21日欧国伟第二次修正版本3.02007年1月29日欧国伟第三次修正版本4.02007年5月27日欧国伟第四次修正版本5.02008年12月06日欧国伟第五次修正版本5.12009年1月16日欧国伟第6次修正版本6201

2、0年1月26日欧国伟第7次修正版本一、必要遵循的规范要求（一）系统结构每个功能模块必须采用分层方式管理代码结构1．各层之间的对象的调用规则a)只能单向、往下调用，即UI层只能调用BLL层的类和对象，BLL层只能通过DAL层调用DB资源b)只能单层调用，即UI层只能调用BLL层的对象，才能访问到DAL层的内容，而不能直接调用DAL层对象。c)Info对象可以独立存在，但是，UI层不能直接生成独立的Info，而只能由BLL生成。d)2．Info层1．Info对象包括两类：（单记录，集合）。目前大部分业务类都是从DataRow，Data

3、Table中继承的1．Info对象一般对应数据库中的数据表（1个或多个），其主要的作用是与DB资源进行交互操作。2．Info层中单记录对象：类似DataRow的概念。他的方法基本很少。基本都是被调用的，以获取属性。一般常有的方法包括a)对象赋值，取值b)对象是否相等-比较c)类型转换d)基本的属性值正确性的验证3．Info层中多记录对象：类似Table的概念，一般的方法包括：a)集合元素的增、减、查找；b)元素类型转换。c)集合概念的正确性验证；4．Info对象本身的操作，目前基本不允许Info有自己的自定义方法。1．UI层1。要

4、尽可能少代码，尽可能轻量级。2。所有业务逻辑尽量全部放置在BLL层，而不要放在UI层。这样可以保持编程的弹性。3。UI层包括的功能：1)UI层应该只放置基本的界面操作的内容，响应用户操作2)管理控件的显示；3)Info的赋值、取值；4)其他参数的赋值、取值；5)显示Info在赋值与取值时的验证提示；6)显示BLL执行方法后的验证提示4．UI层不能直接操作DAL层或直接操作DB资源5。UI中的资料内容，应该都是取自BLL层中的Info的。对Info的操作，除了基本赋值操作外，都要通过BLL对象完成。2．BLL层。BLL层应该集中处理

5、除了数据访问逻辑以外的所有的业务逻辑。包括的内容：1．业务逻辑体类2．通用工具3．DAL层1．所有对数据库的操作，都应该由DAL层执行。2．DAL的一个类，应该对应BLL层的一个业务类；3．DAL的一个方法，应该对应数据库中的一个存储过程。4．传递给DAL层的参数，要么是简单的，要么是Info层定义的对象5．DAL应该包括的操作有：a)分解传入参数值，根据不同参数，调用不同的存储过程；b)把存储过程返回值传回上层；4．DB资源层泛指所有系统资源，包括远程数据库、本地数据表、资源文件、配置文件等对于数据库来说，数据处理的逻辑基本上都

6、集中在数据库中处理。（二）编码规范uC#1．所有变量都要按照先定义，后使用的顺序使用。2．对于不同类型的变量、常量、模块、过程、类等，使用有意义的名字可以增强程序的可读性。a)对于英文项目：所有名字都以英文单词为基础，而不要以拼音。b)对于中文项目：所有名字都以中文为基础，建议在中文名的最开始部分是英文或符号。3．命名规范l类名使用Pascal大小写形式　　publicclassHelloWorld{...}　　l方法使用Pascal大小写形式　　publicclassHelloWorld{voidSayHello(stringn

7、ame){...}}　　l属性使用Pascal大小写形式publicclassHelloWorld{publicDataTableTableGrpTracerWeekly{get{return_tableGrpTracerWeekly;}}//Weekly收视率录入}　　l字段（通过‘属性’对外公开的）使用Camel大小写形式，并且在名称开始加下横线”_”Privateint_id;l变量和方法参数使用Camel大小写形式　　　　publicclassHelloWorld{inttotalCount=0;voidSayHello(

8、stringname){stringfullMessage="Hello"+name;...}}l控件使用控件名小写+”_”+Pascal大小写形式Buttonbutton_Find=newButton();l单字母作为变量名称（如ijk…），只能