某知名網(wǎng)站軟件開發(fā)規(guī)范

   【世界經(jīng)理人編者按】 某知名網(wǎng)站軟件開發(fā)規(guī)范

1 數(shù)據(jù)庫使用規(guī)范

1.1服務(wù)器上有關(guān)數(shù)據(jù)庫的一切操作只能由服務(wù)器管理人員進行。
1.2程序中訪問數(shù)據(jù)庫時使用統(tǒng)一的用戶、統(tǒng)一的連接文件訪問數(shù)據(jù)庫。
1.3原則上每一個頻道只能建一個庫，庫名與各頻道的英文名稱相一致，庫中再包含若干表。比較大的、重點的欄目可以考慮單獨建庫，庫名與欄目的英文名稱相一致。
1.4命名：
（1） 數(shù)據(jù)庫、表、字段、索引、視圖等一系列與數(shù)據(jù)庫相關(guān)的名稱必須全部使用與內(nèi)容相關(guān)的英文單詞命名（盡量避免使用漢語拼音），對于一個單詞難以表達的，可以考慮用多個單詞加下劃線（_）連接（不能超過四個單詞）命名。
（2） 所有的名稱必須統(tǒng)一使用英文小寫字母。
（3） 所有的名稱起始和結(jié)尾不能使用下劃線（_）。
（4） 所有的名稱不能包含26個英文小寫字母和下劃線（_）以外的其他字符。
1.5不再使用的數(shù)據(jù)庫、表應(yīng)刪除，在刪除之前必須備份（包括結(jié)構(gòu)和內(nèi)容）。

2 文檔規(guī)范

所有的項目必須有相關(guān)的文檔說明（可以是電子文檔）。文檔應(yīng)包含如下內(nèi)容：
（1）項目名稱。
（2）項目小組名單，項目負責(zé)人。
（3）項目開發(fā)起始時間和結(jié)束時間。
（4）項目內(nèi)容描述。
（5）項目位置。（在哪個頻道、哪個欄目）
（6）與項目有關(guān)的程序文件名（含路徑名），文件內(nèi)容及實現(xiàn)的功能描述。
（7）完整的程序流程圖。
（8）數(shù)據(jù)庫、表、視圖、索引的名稱，用途。字段的名稱、類型、長度、用途，必須附上相關(guān)的sql語句。

3源代碼與頁面嵌套規(guī)范

3.1源代碼：
（1） 使用自定義變量（包括全局變量、局部變量）之前必須先聲明變量，并用注釋語句標(biāo)明變量的類型、用途。
（2）自定義函數(shù)必須用注釋語句標(biāo)明函數(shù)的用途、參數(shù)的數(shù)據(jù)類型、意義，返回值的類型。
（3）程序中重要的過程或代碼較長的過程應(yīng)使用注釋語句標(biāo)明該過程的起始行和結(jié)束行，并注明該過程的功能。
（5） 所有的注釋文字一律使用簡體中文。

3.2 html頁面嵌套：
（1） 網(wǎng)頁設(shè)計部設(shè)計的html頁面以嵌套的方式確定用于動態(tài)顯示程序執(zhí)行結(jié)果的位置、寬度、行數(shù)（或高度）等，并在相應(yīng)位置予以文字說明。頁面中與程序無關(guān)的圖片、文字、聯(lián)結(jié)等必須使用完整的url。
（2） 軟件開發(fā)人員和編輯人員可以根據(jù)情況協(xié)商，將頁面文件及圖片與程序獨立存放在各自的服務(wù)器上，頁面改版和修改程序獨立進行。
（3） 使用include技術(shù)將分割開的html頁面分別嵌入程序代碼中，要求做到修改html頁面時無須改寫程序，而修改程序時不會影響html頁面效果，將頁面改版和修改程序兩項工作分別獨立。
（4） 頁面和程序嵌套以后不能破壞原h(huán)tml頁面的整體顯示效果，字體、字號、顏色等應(yīng)盡量保持原h(huán)tml頁面的風(fēng)格。
（5） 動態(tài)生成的頁面的各項指標(biāo)（如圖片大小、頁面寬度、高度、頁面文件的字節(jié)數(shù)等）應(yīng)符合本公司網(wǎng)頁設(shè)計方面的要求。

4測試規(guī)范（軟件部分）

對于較大的項目應(yīng)成立相應(yīng)的測試小組，小組成員由軟件開發(fā)人員、網(wǎng)頁設(shè)計人員、技術(shù)人員、編輯人員組成。測試過程應(yīng)參照網(wǎng)頁設(shè)計部為該項目提供的原h(huán)tml頁面進行。測試內(nèi)容包括以下幾點：
（1） 頁面寬度、高度（行數(shù)）。
（2） 頁面文字、圖片、色彩是否風(fēng)格統(tǒng)一。
（3）頁面的圖片顯示是否正常、有無變形。
（4）彈出頁面的效果。
（5）頁面的聯(lián)接是否正確。
（6）動態(tài)生成的頁面是否符合以上幾個方面的要求，頁面大?。ㄗ止?jié)數(shù)，包括頁面的圖片、*.js、*.css、*.class等相關(guān)文件）是否符合網(wǎng)頁設(shè)計的要求。

（7） 軟件方面的功能是否實現(xiàn)。如數(shù)據(jù)庫的查詢、修改、刪除，文件的上傳、下載等操作是否正常。
（8） 測試結(jié)束后，根據(jù)《軟件開發(fā)需求書》在《測試報告》上如實填寫測試結(jié)果，包括測試通過的、未通過的，指出出錯的頁面和相關(guān)的程序文件，并附上測試中出現(xiàn)的錯誤信息。