项目开发计划书节选

项目相关定义每个团队开发都应有自己的一套规范，一个优良可行的规范可以使我们工作得心应手事半功倍。由于此项目开发的分散性、独立性、整合的交互性等，为了有利于项目的整体风格统一、代码维护和扩展，所以定制了这套简单的约定和规则。本文档将定制一系列约定和规则，他们分别包括代码目录约定、文件夹命名规则、文件名命名规则、程序代码编程风格、数据库设计约定。这些规则和约定需要与开发人员、设计人员和维护人员共同讨论定制，将来开发都将严格按规则或约定开发2.1.1项目目录约定****电信[数字***]英文DigitizeSLSysProject目录（即DigitizeSLSys）

|Inc\

公用服务器端函数定义(整个项目公用)

|JsInc\

JavaScript共用函数(整个项目公用)

|Database\数据库相关文件（如为sqlserver,把*.sql放到这里面）

|Include\

引用头文件(top等，整个项目公用)|首页相关页面程序代码文件

|模块目录\

（每个模块都按此约定）

|

|Inc\

公用服务器端函数定义(本模块公用，比如数据库连接)

|

|JsInc\

JavaScript共用函数(本模块公用)

|

|UpPic\

上传图片的保存目录

|

|Upfile\

上传文件的保存目录

|

|Images\

图片的目录

|

|Css\

页面css风格目录

|

|Include\

引用头文件(top等)

|

|页面程序代码文件

|Admin\管理的代码|

|Inc\

公用服务器端函数定义(本模块公用，比如数据库连接)

|

|JsInc\

JavaScript共用函数

|

|Images\

图片的目录

|

|Css\

页面css风格目录

|

|Include\

引用头文件(top等)

|

|页面程序代码文件2.1.2项目开发环境体系结构：B/S服务器运行环境：MicrosoftWindows2000Server/Windows2003serverWEB服务器：

IIS5.0/IIS6.0开发平台：MicrosoftVisualStudio.NET2005+Dreamweaver8

ASP.NET开发语言：C#数据库系统：MicrosoftSQLServer2005关键技术：C#+Ajax代码管理：MicrosoftVisualSourceSafe20052.1.3项目代码约定文件命令约定（包括图片文件）1.

文件名只能用英文字母，第一个字母大写，每个单词第一个字母大写,长度不要超过20字符。例：NewsLogo.gif2.

代码和界面分离：每一个页面的界面用*.aspx命名，实现代码用*.cs。3.

类别相同文件的命名分为头和尾两部分，如：RegisterForm.aspx

RegisterPost.aspx

LogoNews.gif

LogForum.gif这样是为了方便如果我们按文件名称排列的时候，相同类别的文件能够在一起。编码约定1.

数据库连接符：Web.config文件：<?xmlversion="1.0"encoding="utf-8"?><!--

注意:除了手动编辑此文件以外，您还可以使用

Web管理工具来配置应用程序的设置。可以使用VisualStudio中的

“网站”->“Asp.Net配置”选项。

设置和注释的完整列表在

ments中，该文件通常位于

\Windows\Microsoft.Net\Framework\v2.x\Config中--><configuration>

<appSettings>

<addkey="DataConnectionString"value="workstationid=edg;packetsize=4096;userid=Test;datasource=localhost;persistsecurityinfo=False;initialcatalog=TestDB;password=123"/>

</appSettings>

<connectionStrings/>

<system.web>

<!--

设置compilationdebug="true"将调试符号插入

已编译的页面中。但由于这会

影响性能，因此只在开发过程中将此值

设置为true。

-->

<compilationdebug="true"/>

<!--

通过<authentication>节可以配置ASP.NET使用的

安全身份验证模式，

以标识传入的用户。

-->

<authenticationmode="Windows"/>

<!--

如果在执行请求的过程中出现未处理的错误，

则通过<customErrors>节可以配置相应的处理步骤。具体说来，

开发人员通过该节可以配置

要显示的html错误页

以代替错误堆栈跟踪。

-->

<customErrorsmode="RemoteOnly"defaultRedirect="GenericErrorPage.htm">

<errorstatusCode="403"redirect="NoAccess.htm"/>

<errorstatusCode="404"redirect="FileNotFound.htm"/>

</customErrors>

</system.web></configuration>2.

实际调运的ADO.NET运用

usingSystem;usingSystem.Data;usingSystem.Configuration;usingSystem.Web;usingSystem.Web.Security;usingSystem.Web.UI;usingSystem.Web.UI.WebControls;usingSystem.Web.UI.WebControls.WebParts;usingSystem.Web.UI.HtmlControls;usingSystem.Data.SqlClient;

/**********************************************************************************作者：AndyLu**创始时间：2007-02-13**修改人：AndyLu**修改时间：2007-02-13**描述：**主要用于用户注册*********************************************************************************/

///<summary>///用户注册类(用户注册，并返回ID)///</summary>

publicpartialclass_Default:System.Web.UI.Page{

protectedvoidPage_Load(objectsender,EventArgse)

{

}

protectedvoidButton1_Click(objectsender,EventArgse)

{

//VS2003用：System.Configuration.ConfigurationSettings.AppSettings

SqlConnectionConn=newSqlConnection(System.Configuration.ConfigurationManager.AppSettings.Get(

Conn.Open();

SqlCommandCmdInsert=newSqlCommand("Users_Insert",Conn);

CmdInsert.CommandType=CommandType.StoredProcedure;

//VS2003只用：CmdInsert.Parameters.Add

CmdInsert.Parameters.AddWithValue("@UserType",UserType.Text.ToString());

CmdInsert.Parameters.AddWithValue("@UserName",UserName.Text.ToString());

CmdInsert.Parameters.AddWithValue("@UserPassWord",UserPassWord.Text.ToString());

CmdInsert.Parameters.AddWithValue("@UserEmail",UserEmail.Text.ToString());

SqlParameterparmReturnValue=newSqlParameter("@Userid",SqlDbType.Int);

intintAuthorCount;

parmReturnValue.Direction=ParameterDirection.Output;

CmdInsert.Parameters.Add(parmReturnValue);

SqlTransactionTrans=Conn.BeginTransaction();

try

{

CmdInsert.Transaction=Trans;

CmdInsert.ExecuteNonQuery();

intAuthorCount=(int)CmdInsert.Parameters["@Userid"].Value;

Trans.Commit();

Response.Write("<script>alert('祝贺您！用户添加成功!');</script>");

Response.Write(intAuthorCount);

CmdInsert.Dispose();

Conn.Close();

}

catch(ExceptionErr)

{

Response.Write(Err.Message);

}3.

过程函数:--================================================SETANSI_NULLSONGOSETQUOTED_IDENTIFIERONGO--=============================================--Author:

AndyLu--Createdate:2007-2-1210:46--Description:

用户注册--

参数-UserId：用户ID；--

参数-UserType：用户类型；--

参数-UserName：用户名称；--

参数-UserPassWord：用户密码；--

参数-UserEmail：用户邮箱；--=============================================CREATEPROCEDURE[dbo].[Users_Insert]@UserIdintoutput,@UserTypeint,@UserNamenvarchar(50),@UserPassWord

nvarchar(50),@UserEmailnvarchar(50)AS

begintran

INSERTINTO[UserInfo]

(

[usertype],

[username],

[userpassword],

[UserEmail])

values(@UserType,@UserName,@UserPassWord,@UserEmail)

if@@error<>0gotoerrorset@UserId=@@identity

Committranreturn

--事务处理ERROR:

set@UserId=0

rollbacktrango变量约定.1变量约定每个变量第一个字母小写，以后每个单词第一个字母大写。出于易读和一致性的目的，变量名字的前缀定义如下：子类型前缀示例BooleanblnblnFoundBytebytbytDataDate(Time)dtmdtmStartDoubledbldblToleranceErrorerrerrOrderNumIntegeriiQuantityLongllQuantityObjectobjobjCurrentSinglesngsngAverageStringstrstrFirstNameArrayarrarrName.2变量格式格式如下:stringstrStfId=Session["UserId"].ToString().Trim();stringstrStfId=Request.QueryString.GetValues("StfId").GetValue(0).ToString();.3控件约定建议是使用控件名简写作为前缀，并且简写的首字母小写，符合Camel规范。格式：控件名简写+英文描述，英文描述首字母大写主要控件名简写对照表序号控件名控件简写备注1LabellbllblId2TextBoxtxttxtName3ButtonbtnbtnOk4CheckBoxchkchkSex5RadioButtonrdo

6CheckBoxListchklst

7RadioButtonListrdolst

8ListBoxlst

9DropDownListddl

10DataGriddg

11DataListdl

12Imageimg

13Tabletbl

14Panelpnl

15LinkButtonlnkbtn

16ImageButtonimgbtn

17Calendercld

18AdRotatorar

19RequiredFieldValidatorrfv

20CompareValidatorcv

21RangeValidatorrv

22RegularExpressionValidatorrev

23ValidatorSummaryvs

24CrystalReportViewerrptvew

数据库约定.1命名约定1.

库的命名：只能用英文字母，第一个字母大写，每个单词第一个字母大写,长度不要超过20字符。2.

Table命名约定：只能用英文字母，第一个字母大写，每个单词第一个字母大写,长度不要超过30字符。3.

字段命名：只能用英文字母，第一个字母小写，每个单词第一个字母大写,长度不要超过30字符。.1连接库约定1.

在程序连接库的时候请不要用sa账号，请用为每一个库单独添加的user账号连接。也就是说每建一个新库，要单独给他一个是用账号，这个帐号提供给程序中用。2.

在程序中请使用ADO.NET连接注释.1头文件注释在代码文件的头部进行注释，标注出创始人、创始时间、修改人、修改时间、代码的功能，这在团队开发中必不可少，它们可以使后来维护/修改的同伴在遇到问题时，在第一时间知道他应该向谁去寻求帮助，并