项目开发计划书节选.doc

项目开发计划书节选 项目相关定义每个团队开发都应有自己的一套规范，一个优良可行的规范可以使我们工作得心应手事半功倍。 由于此项目开发的分散性、独立性、整合的交互性等，为了有利于项目的整体风格统 一、代码维护和扩展，所以定制了这套简单的约定和规则。 本文档将定制一系列约定和规则，他们分别包括代码目录约定、文件夹命名规则、文件名命名规则、程序代码编程风格、数据库设计约定。 这些规则和约定需要与开发人员、设计人员和维护人员共同讨论定制，将来开发都将严格按规则或约定开发2.1.1项目目录约定*电信数字*英文DigitizeSLSys-Proj ect目录（即DigitizeSLSys）|-I nc公用服务器端函数定义(整个项目公用)|-JsI ncJavaScript共用函数(整个项目公用)|-Database数据库相关文件（如为sqlserver,把*.sql放到这里面）|-I nclude引用头文件(top等，整个项目公用)|-首页相关页面程序代码文件|-模块目录（每个模块都按此约定）|-I nc公用服务器端函数定义(本模块公用，比如数据库连接)|-JsI ncJavaScript共用函数(本模块公用)|-UpPic上传图片的保存目录|-Upfile上传文件的保存目录|-I mages图片的目录|-Css页面css风格目录|-I nclude引用头文件(top等)|-页面程序代码文件|-Admin管理的代码|-I nc公用服务器端函数定义(本模块公用，比如数据库连接)|-JsI ncJavaScript共用函数|-I mages图片的目录|-Css页面css风格目录|-I nclude引用头文件(top等)|-页面程序代码文件2.1.2项目开发环境体系结构B/S服务器运行环境Microsoft Windows2000Server/Windowsxxserver WEB服务器I IS5.0/I IS6.0开发平台Microsoft Visual Studio.NETxx+Dream weaver8开发语言数据库系统关键技术代码管理ASP.NET C#Microsoft SQLServerxxC#+Aj axMicrosoft VisualSourceSafexx2.1.3项目代码约定文件命令约定（包括图片文件）1.文件名只能用英文字母，第一个字母大写，每个单词第一个字母大写,长度不要超过20字符。 例NewsLogo.gif2.代码和界面分离每一个页面的界面用*.aspx命名，实现代码用*.cs。 3.类别相同文件的命名分为头和尾两部分，如RegisterForm.aspx RegisterPost.aspx LogoNews.gif LogForum.gif这样是为了方便如果我们按文件名称排列的时候，相同类别的文件能够在一起。 编码约定1.数据库连接符Web.config文件2.实际调运的ADO.NET运用using System;using System.Data;using System.Configuration;using System.Web;using System.Web.Security;using System.Web.UI;using System.Web.UI.WebControls;using System.Web.UI.WebControls.WebParts;using System.Web.UI.HtmlControls;using System.Data.SqlClient;/*作者Andy Lu*创始时间xx-02-13*修改人Andy Lu*修改时间xx-02-13*描述*主要用于用户注册*/ (50),UserPassWord nvarchar (50),UserEmail nvarchar (50)AS begintran INSERT INTOUserI nfo(usertype,usernam e,userpassword,UserEmail)values(UserType,UserNam e,UserPassWord,UserEmail)iferror0goto errorsetUserI d=identity Commit tranreturn-事务处理ERROR:setUserI d=0rollback trango变量约定.1变量约定每个变量第一个字母小写，以后每个单词第一个字母大写。 出于易读和一致性的目的，变量名字的前缀定义如下子类型前缀示例Boolean blnblnFound Bytebyt bytDataDate(Tim e)dtm dtmStart Doubledbl dblToleranceError errerrOrderNum Integer iiQuantity Longl lQuantityObj ectobj objCurrentSingle sngsngAverage Stringstr strFirstName Arrayarr arrName.2变量格式格式如下:string strStfI d=SessionUserI d.ToString().Trim();string strStfId=Request.QueryString.GetValues(StfId).GetValue (0).ToString();.3控件约定建议是使用控件名简写作为前缀，并且简写的首字母小写，符合Camel规范。 格式控件名简写+英文描述，英文描述首字母大写主要控件名简写对照表序号控件名控件简写备注1Label lbllblI d2TextBox txttxtNam e3Button btnbtnOk4CheckBox chkchkSex5RadioButton rdo6CheckBoxList chklst7RadioButtonList rdolst8ListBox lst9DropDownList ddl10DataGrid dg11DataList dl12I mage img13Table tbl14Panel pnl15LinkButton lnkbtn16I mageButton imgbtn17Calender cld18AdRotator ar19RequiredFieldValidator rfv20Com pareValidatorcv21RangeValidator rv22RegularExpressionValidator rev23ValidatorSum maryvs24CrystalReportViewer rptvew数据库约定.1命名约定1.库的命名只能用英文字母，第一个字母大写，每个单词第一个字母大写,长度不要超过20字符。 2.Table命名约定只能用英文字母，第一个字母大写，每个单词第一个字母大写,长度不要超过30字符。 3.字段命名只能用英文字母，第一个字母小写，每个单词第一个字母大写,长度不要超过30字符。 .1连接库约定1.在程序连接库的时候请不要用sa账号，请用为每一个库单独添加的user账号连接。 也就是说每建一个新库，要单独给他一个是用账号，这个帐号提供给程序中用。 2.在程序中请使用ADO.NET连接注释.1头文件注释在代码文件的头部进行注释，标注出创始人、创始时间、修改人、修改时间、代码的功能，这在团队开发中必不可少，它们可以使后来维护/修改的同伴在遇到问题时，在第一时间知道他应该向谁去寻求帮助，并且知道这个文件经历了多少次迭代、经历了多少个程序员的手。 例如/*作者Andy Lu*创始时间xx-02-13*修改人Andy Lu*修改时间xx-02-13*描述*主要用于用户注册*/注我们甚至可以在这段文件头注释中加入版权信息、文件名、版本信息等。 .2函数、属性、类等注释（可扩充）请使用/三斜线注释，这种注释是基于XML的，不仅能导出XML制作帮助文档，而且在各个函数、属性、类等的使用中，环境会自动带出注释，方便你的开发。 以protected，protected Internal，public声明的定义注释请都以这样命名方法。 比如/ 在注释中写明我们的逻辑思想，对照程序，判断程序是否符合我们的初衷，如果不是，则我们应该仔细思