動態網頁製作規範

來源:互聯網
上載者:User
動態|規範|網頁 一、 目錄結構
目錄結構的命名規則以英文字母或拼音縮寫作為目錄名。寫明每個目錄下建立一個Readme.doc的Word檔案,寫明該目錄下檔案的情況,包含檔案名稱、主要說明或用途、修改人及修改時間。
1. 第一層排放系統管理目錄、來源程式目錄、文檔目錄、SQL指令碼目錄、公用資來源目錄、來源程式備份目錄,來源程式目錄下存放動態指令碼及首頁頁面,文檔目錄下存放項目相關文檔,SQL指令碼目錄下存放項目相關SQL指令碼,公用資來源目錄下存放項目相關的PSD檔案、動畫檔案的公用資源,目錄命名為:
◆ 系統管理目錄:00_System
◆ 來源程式目錄:01_Source
 ▲ 靜態網頁
 ▲ 動態指令碼
  ◎ 通用指令碼目錄:01_Public
  ◎ 圖形目錄:02_Img
  ◎ 子系統目錄1:03_XXXX
  ◎ 子系統目錄2:04_XXXX
  ◎ .
  ◎ .
  ◎ .
◆ 文檔目錄:02_Document
◆ SQL指令碼目錄:03_SQL
◆ 公用資來源目錄:04_Resource
 ▲ PSD檔案目錄:05_PSD
 ▲ Flash動畫檔案目錄:02_FLA
◆ 來源程式備份目錄:05_BAK
2. 系統管理目錄存放系統維護程式的原始碼及目標代碼;
3. 文檔目錄(02_Document)下必須包含存放網站的設計方案、調研報告、動態網頁的詳細設計、安裝說明、系統維護程式使用說明、網頁檔案組織說明及相關的資料等;
4. 來源程式備份目錄:按來源程式目錄結構存放需備份的檔案。
5. 來源程式目錄(01_Source)下子目錄結構分成兩個大的部分,將靜態網頁及動態網頁分開存放,動態指令碼儘可能少的直接嵌入靜態網頁中,若有必要則以函數的形式組織指令碼,在靜態網頁中選擇插入點調用該函數。在動態網頁指令碼中的靜態部分,可以html檔案的形式存放,在動態指令碼中將其包含進來。
6. 通用指令碼目錄(01_Public)下存放動態指令碼的一些公用的指令碼源碼,例如串連資料庫指令碼、自訂的公用函數、CSS檔案、公用的Javascript指令碼。各子系統目錄名以拼音的方式命名。
7. 備份檔案:將日後有可能要用的檔案在注釋中標明日期等資訊,轉移至備份目錄。
8. 及時刪除無用的檔案;
9. 網頁檔案組織說明:網站檔案的組織圖關係。


二、 檔案規格
1. 通用指令碼依據功能用途建立指令檔,為避免因指令檔過大而影響指令碼的解析速度,控制指令碼的檔案大小。
2. 指令碼中的檔案頭及自訂函數、過程等的程式頭參照附錄的規範建立注釋,包括代碼用途、傳入參數、傳出參數、修改記錄。
3. 動態指令碼中Html的控制項名稱命名使用該空間類型的全稱 + 控制項含義。
4. 變數的命名參照附錄規範。
5. 函數的命名參照附錄規範。
6. 指令碼語句格式空格為3格。
7. 在運算子號或=的左右應用空格將運算子號或=與變數或運算式區分開來。例如:$strTmp = $Text + $strTmp。寫連結時除外;
8. 年份、月份及日期的輸入方式為下拉框選擇方式。
9. 指令碼中的注釋根據不同的開發工具具體再定。

附錄: 編程規範
◆ 每個頁面的頁面總體注釋必須有,樣本如下:

// =================================================================
// 代碼描述: 從資料庫中取得查詢資料,分頁顯示
//
// 入口參數: 無
//
// 返回結果: 查詢資料
//
// 修改記錄: 姓名 日期 內容
//
// =================================================================

◆ 函數
 ▲ 函數名定義:
¨ 全域函數(Global Function):g_f_ + 函數名稱(使用英文表達含義,如有多單詞用'_'隔開,每個單詞的第一個字母應大寫)。
¨ 外部函數(Extend Function):遵循原有名稱。
¨ 表單函數(Window Function):w_f_ + 函數名稱(使用英文表達含義,如有多單詞用'_'隔開,每個單詞的第一個字母應大寫)。
 ▲ 參變數定義,遵循指令碼中局域變數定義要求。
◆ 指令碼
 ▲ 變數定義:
¨ 全域變數(Global Variables):g_ + 變數類型的第一個字母(如:String類型為s) + 變數名稱(使用英文表達含義,如有多單詞用'_'隔開,每個單詞的第一個字母應大寫)。
¨ 執行個體變數(Instance Variables):i_ + 變數類型的第一個字母(如:String類型為s) + 變數名稱(使用英文表達含義,如有多單詞用'_'隔開,每個單詞的第一個字母應大寫)。
¨ 局域變數:變數類型(簡寫) + 變數名稱(使用英文表達含義,如有多單詞不用'_'隔開,但每個單詞的第一個字母應大寫)。例如:String 類型 strTmp, Integer 類型 intRowNO。
 ▲ 保留字及SQL保留字應按原書寫方法,首字母大寫的原則(如:If....Else....End If)。
 ▲ 所有的嵌入的ASP指令碼全部靠在左端,指令碼和嵌入符之間空一行。

HTML CODE HTML CODE HTML CODE HTML CODE <%
'空一行
ASP Statements...
If Condition Then
ASP Statements...
End If
ASP Statements...
'空一行
%> HTML CODE HTML CODE HTML CODE HTML CODE
 ▲ 所有條件陳述式、迴圈語句的程式體應縮排。
 ▲ 上一語句未完,用'&'延續的部分縮排。
 ▲ 通過Tab鍵縮排,杜絕使用空格縮排,以免照成在Tab數不同的環境下縮排紊亂。
 ▲ 在運算子號或=的左右應用空格將運算子號或=與變數或運算式區分開來。例如:strTmp = edit_1.Text + strTmp。
 ▲ 在,後加空格。例如:SELECT Department_NO, Department_Name FROM ....。
 ▲ 在指令碼語句、流程、函數、類前應加註釋,說明該語句或流程實現功能。
◆ 其餘
 ▲ 遵循程式檔案的目錄存放結構。
 ▲ 盡量不在資料庫端編寫觸發器來自動插入序號,可在程式指令碼(盡量在儲存事件而不是新增事件)中寫代碼取序號。
 ▲ 所有資料庫的視圖、過程、函數等應各自形成.SQL檔案,檔案名稱為本身對象的名字,如RS_V_.../SB_P_.../YX_F_...等。附屬不單獨使用的視圖可放在主視圖的.SQL檔案中。
 ▲ 觸發子與序號結合使用時可合并在同一.SQL語句中,以觸發子名字命名。
 ▲ 所有資料庫的授權應每個子系統形成一個檔案,名為Grant.SQL。
◆ 該規範為試行規範,在遵循過程中如有意見可向專案經理提出,對於小範圍的違反專案經理可根據實際情況酌情予以審定,大規模的變動需向公司提出,由公司同意後執行。
◆ 對於試行版的修改,公司將以最快速度通知各項目組。



相關文章

E-Commerce Solutions

Leverage the same tools powering the Alibaba Ecosystem

Learn more >

Apsara Conference 2019

The Rise of Data Intelligence, September 25th - 27th, Hangzhou, China

Learn more >

Alibaba Cloud Free Trial

Learn and experience the power of Alibaba Cloud with a free trial worth $300-1200 USD

Learn more >

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。