项目开发规范性文档.doc

《项目开发规范性文档.doc》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、项目开发规范性文档一:作用项目开发过程中为了增加程序的可读性和程序的健壮性，方便后期程序的调试和维护，所以需要在开发过程中统一技术规范二:目录1.系统框架中模块功能，文件目录和文件名的规范2.程序代码中文件名类名 变量名接口名等规范3.代码的书写的规范 4.数据库中表名字段名数据类型等规范三:详细内容说明 常用的命名风格如下。(1)Pascal风格：包含一到多个单词，每一个单词第一个字母大写，其他字母小写，其余字母均小写。例如：CollegeStudent、HelloWorld等。(2)Camel风格：包含一到多个单词，第一个

2、单词首字母小写，其余单词首字母大写，其他字母均小写。例如：name、gender、somePara等。1.系统框架功能模块、文件目录和文件名的规范(1)功能模块命名规范数据访问层(DAL)——DataSet，与数据库打交道的唯一方式；位于最底层；数据控制层(DCL)——直接与DataSet打交道，通过实体工厂类产生实体对象和数据访问层打交道数据封装层(DPL)——BEAN实体类;业务逻辑层(BLL)——与业务有关的操作，以上三层多不与业务逻辑有关;通用工具层(CTL)——与项目无关、可独立的类库。如DBControl,Exce

3、ption等;系统管理层(SysManeger)--系统管理常用接口比如系统日志系统版本 系统信息等数据访问接口层(IDataFactory)--数据访问层的抽象工厂接口实体访问接口层(EntityFactory)--数据访问层的实体工厂类，即产生实体对象的实体工厂类(2)文件目录的命名规范images--项目图片的目录styles --项目css文件的目录javascript--项目中js文件的目录template --项目模板文件的目录subsystem--项目子系统或模块的目录(一般用因为名字来表示系统的模块)docum

4、ent --项目说明文档目录database --项目数据库目录(3)文件名的命名规范a.文件名尽量用一个或多个英文单词来表示做到见面知意的效果比如:Index.aspx Default.aspx Product.aspx OrderList.aspx等b.所有单词的首字母要大些c.尽量不要使用下划线来连接多个单词2.程序代码中的命名规范(1)命名空间命名空间命名采用Pascal风格，取名的一般规则如下。CompanyName.TechnologyName例如：Microsoft.OfficeMyCompany.NamingR

5、ule.Test另外，需要用复数的时候要使用复数的名称空间名。例如，使用System.Collections而不是System.Collection。但是，当遇到缩写形式时，通常不需要使用复数。例如：使用System.IO而不是System.IOs。名称空间和类不能使用同样的名字。例如，有一个类被命名为Student后，就不要再使用Student作为一个名称空间。(2)类C#中的类命名采用Pascal命名风格，取名的规则如下。a.在为类命名前首先要知道该类的作用，尽量以名词或名词短语命名，使程序员通过类名提供的线索，便可以了解

6、这个类的基本功能。b.尽量不使用缩写，而用全写。例如：使用CollegeStudent而不用CollegeStu。c.不要使用任何类前缀(例如C)和后缀(例如Class)。d.不要使用带下划线的字符(例如College_Student)。代码19-1 类命名示例pulibcclassCollegeStudent{}(3)私有成员类的成员变量采用Camel风格，并使用前缀m_或者_。下面是一些合理的私有成员示例。代码19-2 私有成员命名示例classCollegeStudent{     privatestringm_name

7、;     privateintm_age;}(4)属性类的属性采用Pascal风格。下面是一些合理的属性示例。代码19-3 属性命名示例classCollegeStudent{     publicstringName     {           set           {                    if(value!=null)                          this.m_name=value;           }           get           {       

8、             returnthis.m_name;           }    }}(5)方法通常每个方法都是执行类的一个“动作”，所以对方法的命名应该清楚地说明该方法是做什么的，用“动词+名词”的结构可以更加清晰的表达这种含义。例如，用ShowInfo()代替