項(xiàng)目開發(fā)計(jì)劃書節(jié)選

項(xiàng)目相關(guān)定義每個(gè)團(tuán)隊(duì)開發(fā)都應(yīng)有自己的一套規(guī)范，一個(gè)優(yōu)良可行的規(guī)范可以使我們工作得心應(yīng)手事半功倍。由于此項(xiàng)目開發(fā)的分散性、獨(dú)立性、整合的交互性等，為了有利于項(xiàng)目的整體風(fēng)格統(tǒng)一、代碼維護(hù)和擴(kuò)展，所以定制了這套簡單的約定和規(guī)則。本文檔將定制一系列約定和規(guī)則，他們分別包括代碼目錄約定、文件夾命名規(guī)則、文件名命名規(guī)則、程序代碼編程風(fēng)格、數(shù)據(jù)庫設(shè)計(jì)約定。這些規(guī)則和約定需要與開發(fā)人員、設(shè)計(jì)人員和維護(hù)人員共同討論定制，將來開發(fā)都將嚴(yán)格按規(guī)則或約定開發(fā)2.1.1項(xiàng)目目錄約定****電信[數(shù)字***]英文DigitizeSLSysProject目錄（即DigitizeSLSys）

|Inc\

公用服務(wù)器端函數(shù)定義(整個(gè)項(xiàng)目公用)

|JsInc\

JavaScript共用函數(shù)(整個(gè)項(xiàng)目公用)

|Database\數(shù)據(jù)庫相關(guān)文件（如為sqlserver,把*.sql放到這里面）

|Include\

引用頭文件(top等，整個(gè)項(xiàng)目公用)|首頁相關(guān)頁面程序代碼文件

|模塊目錄\

（每個(gè)模塊都按此約定）

|

|Inc\

公用服務(wù)器端函數(shù)定義(本模塊公用，比如數(shù)據(jù)庫連接)

|

|JsInc\

JavaScript共用函數(shù)(本模塊公用)

|

|UpPic\

上傳圖片的保存目錄

|

|Upfile\

上傳文件的保存目錄

|

|Images\

圖片的目錄

|

|Css\

頁面css風(fēng)格目錄

|

|Include\

引用頭文件(top等)

|

|頁面程序代碼文件

|Admin\管理的代碼|

|Inc\

公用服務(wù)器端函數(shù)定義(本模塊公用，比如數(shù)據(jù)庫連接)

|

|JsInc\

JavaScript共用函數(shù)

|

|Images\

圖片的目錄

|

|Css\

頁面css風(fēng)格目錄

|

|Include\

引用頭文件(top等)

|

|頁面程序代碼文件2.1.2項(xiàng)目開發(fā)環(huán)境體系結(jié)構(gòu)：B/S服務(wù)器運(yùn)行環(huán)境：MicrosoftWindows2000Server/Windows2003serverWEB服務(wù)器：

IIS5.0/IIS6.0開發(fā)平臺(tái)：MicrosoftVisualStudio.NET2005+Dreamweaver8

ASP.NET開發(fā)語言：C#數(shù)據(jù)庫系統(tǒng)：MicrosoftSQLServer2005關(guān)鍵技術(shù)：C#+Ajax代碼管理：MicrosoftVisualSourceSafe20052.1.3項(xiàng)目代碼約定文件命令約定（包括圖片文件）1.

文件名只能用英文字母，第一個(gè)字母大寫，每個(gè)單詞第一個(gè)字母大寫,長度不要超過20字符。例：NewsLogo.gif2.

代碼和界面分離：每一個(gè)頁面的界面用*.aspx命名，實(shí)現(xiàn)代碼用*.cs。3.

類別相同文件的命名分為頭和尾兩部分，如：RegisterForm.aspx

RegisterPost.aspx

LogoNews.gif

LogForum.gif這樣是為了方便如果我們按文件名稱排列的時(shí)候，相同類別的文件能夠在一起。編碼約定1.

數(shù)據(jù)庫連接符：Web.config文件：<?xmlversion="1.0"encoding="utf-8"?><!--

注意:除了手動(dòng)編輯此文件以外，您還可以使用

Web管理工具來配置應(yīng)用程序的設(shè)置?？梢允褂肰isualStudio中的

“網(wǎng)站”->“Asp.Net配置”選項(xiàng)。

設(shè)置和注釋的完整列表在

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>

<!--

設(shè)置compilationdebug="true"將調(diào)試符號(hào)插入

已編譯的頁面中。但由于這會(huì)

影響性能，因此只在開發(fā)過程中將此值

設(shè)置為true。

-->

<compilationdebug="true"/>

<!--

通過<authentication>節(jié)可以配置ASP.NET使用的

安全身份驗(yàn)證模式，

以標(biāo)識(shí)傳入的用戶。

-->

<authenticationmode="Windows"/>

<!--

如果在執(zhí)行請(qǐng)求的過程中出現(xiàn)未處理的錯(cuò)誤，

則通過<customErrors>節(jié)可以配置相應(yīng)的處理步驟。具體說來，

開發(fā)人員通過該節(jié)可以配置

要顯示的html錯(cuò)誤頁

以代替錯(cuò)誤堆棧跟蹤。

-->

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

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

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

</customErrors>

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

實(shí)際調(diào)運(yùn)的ADO.NET運(yùn)用

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**創(chuàng)始時(shí)間：2007-02-13**修改人：AndyLu**修改時(shí)間：2007-02-13**描述：**主要用于用戶注冊(cè)*********************************************************************************/

///<summary>///用戶注冊(cè)類(用戶注冊(cè)，并返回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.

過程函數(shù):--================================================SETANSI_NULLSONGOSETQUOTED_IDENTIFIERONGO--=============================================--Author:

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

用戶注冊(cè)--

參數(shù)-UserId：用戶ID；--

參數(shù)-UserType：用戶類型；--

參數(shù)-UserName：用戶名稱；--

參數(shù)-UserPassWord：用戶密碼；--

參數(shù)-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

--事務(wù)處理ERROR:

set@UserId=0

rollbacktrango變量約定.1變量約定每個(gè)變量第一個(gè)字母小寫，以后每個(gè)單詞第一個(gè)字母大寫。出于易讀和一致性的目的，變量名字的前綴定義如下：子類型前綴示例BooleanblnblnFoundBytebytbytDataDate(Time)dtmdtmStartDoubledbldblToleranceErrorerrerrOrderNumIntegeriiQuantityLongllQuantityObjectobjobjCurrentSinglesngsngAverageStringstrstrFirstNameArrayarrarrName.2變量格式格式如下:stringstrStfId=Session["UserId"].ToString().Trim();stringstrStfId=Request.QueryString.GetValues("StfId").GetValue(0).ToString();.3控件約定建議是使用控件名簡寫作為前綴，并且簡寫的首字母小寫，符合Camel規(guī)范。格式：控件名簡寫+英文描述，英文描述首字母大寫主要控件名簡寫對(duì)照表序號(hào)控件名控件簡寫備注1LabellbllblId2TextBoxtxttxtName3ButtonbtnbtnOk4CheckBoxchkchkSex5RadioButtonrdo

6CheckBoxListchklst

7RadioButtonListrdolst

8ListBoxlst

9DropDownListddl

10DataGriddg

11DataListdl

12Imageimg

13Tabletbl

14Panelpnl

15LinkButtonlnkbtn

16ImageButtonimgbtn

17Calendercld

18AdRotatorar

19RequiredFieldValidatorrfv

20CompareValidatorcv

21RangeValidatorrv

22RegularExpressionValidatorrev

23ValidatorSummaryvs

24CrystalReportViewerrptvew

數(shù)據(jù)庫約定.1命名約定1.

庫的命名：只能用英文字母，第一個(gè)字母大寫，每個(gè)單詞第一個(gè)字母大寫,長度不要超過20字符。2.

Table命名約定：只能用英文字母，第一個(gè)字母大寫，每個(gè)單詞第一個(gè)字母大寫,長度不要超過30字符。3.

字段命名：只能用英文字母，第一個(gè)字母小寫，每個(gè)單詞第一個(gè)字母大寫,長度不要超過30字符。.1連接庫約定1.

在程序連接庫的時(shí)候請(qǐng)不要用sa賬號(hào)，請(qǐng)用為每一個(gè)庫單獨(dú)添加的user賬號(hào)連接。也就是說每建一個(gè)新庫，要單獨(dú)給他一個(gè)是用賬號(hào)，這個(gè)帳號(hào)提供給程序中用。2.

在程序中請(qǐng)使用ADO.NET連接注釋.1頭文件注釋在代碼文件的頭部進(jìn)行注釋，標(biāo)注出創(chuàng)始人、創(chuàng)始時(shí)間、修改人、修改時(shí)間、代碼的功能，這在團(tuán)隊(duì)開發(fā)中必不可少，它們可以使后來維護(hù)/修改的同伴在遇到問題時(shí)，在第一時(shí)間知道他應(yīng)該向誰去尋求幫助，并