軟件工程——團隊做業3

一.團隊成員
組長

楊然    1500802102

組員

沈奇    1500802098
汪浩    1500802117
應靜    1500802108
韓英璨  1500802104
趙慧玲  1500802107

二.編碼規範

HTML代碼規範

1.代碼風格
1.1縮進與換行
[建議]使用4個空格做爲一個縮進層級。
[建議]模板代碼的縮進優先保證 HTML 代碼的縮進規則。

1.2命名規則
[強制]class：必須單詞全字母小寫，單詞間以-分隔，且必須表明相應的模塊或部件的內容或功能，不得以html內置樣式進行命名，命名應該具備明確的語義。
[強制]id：必須保持在頁面中的惟一性，命名應該具備明確的語義。

1.3標籤
[強制]Html中的標籤名必須使用小寫字母。
[強制]標籤的閉合要符合html5的規定。
[強制]標籤的使用必須符合標籤的嵌套規則，例：div不得置於p中，tbody必須置於table中。
[建議]標籤的使用必須遵循標籤的語義,例如：
p - 段落
h1,h2,h3,h4,h5,h6 - 層級標題
strong,em - 強調
ins - 插入
del - 刪除
abbr - 縮寫
code - 代碼標識
cite - 引述來源做品的標題
q - 引用
blockquote - 一段或長篇引用
ul - 無序列表
ol - 有序列表
dl,dt,dd - 定義列表
[建議]在CSS能夠實現相同需求的狀況下不得使用表格進行佈局。

1.4屬性

[強制]屬性必須使用小寫字母，其屬性值必須用雙引號包圍。
[建議]布爾類型的建議不添加屬性值。自定義屬性建議以 xxx- 爲前綴，推薦使用data-

2.頁面頭部

2.1 DOCTYPE
[強制]使用doctype 來啓用標準模式，建議使用大寫的 DOCTYPE

2.2語言編碼
[建議]有助於提升頁面的可訪問性，必須設置正確的lang屬性，例：
[強制]頁面必須指定字符編碼的meta，且必須是 head 的第一個直接子元素，例： 。

2.3 CSS和JavaScript引入
[強制]引入css時必須指明rel="stylesheet"，在引入css和javascript時必須指明type屬性。
[建議]Javascript代碼必須放在頁面末尾或採用異步加載。

2.4Head內容
[強制]Title標籤必須設置爲head的直接子元素，並緊隨charset聲明以後。
[強制]Favicon保證可訪問，例：
[強制]Viewport屬性必須指定。

3.圖片
[強制]禁止 img 的 src 取值爲空，延遲加載的圖片也要增長默認的 src屬性值。
[建議]重要圖片添加 alt 屬性值。
[建議]添加 width 和 height 屬性以免頁面抖動。

4.表單

4.1控件標題
[強制]文本標題的控件必須使用 label 標籤將其與其標題相關聯，例： 我已確認上述條款或用戶：

4.2按鈕
[強制]使用 button 元素時必須指明 type 屬性值

4.3可訪問性
[建議]當使用 JavaScript 進行表單提交時，應使原生提交功能正常工做。
[建議] 根據內容類型指定輸入框的 type 屬性，例：

5.多媒體
[建議]使用 audio 以及 video 標籤來播放音頻、視頻時，應當注意格式：
音頻格式：MP三、WAV、Ogg
視頻格式：MP四、WebM、Ogg

6.註釋
[強制]針對頁面或模塊的CSS、javascript代碼必須進行詳細的註釋

PHP代碼規範

命名約定
1.類：
(1)使用大寫字母做爲詞的分割，其餘的字母均使用小寫；
(2)名字的首字母使用大寫;
(3)不要使用下劃線('_')；
如：Name、SuperMan、BigClassObject。

2.函數：
(1)函數名只包含字母數字的字符，數字是容許的但大多數狀況下不鼓勵；
(2)函數名老是以小寫開頭，當函數名包含多個單詞，在首單詞後的全部單詞首字母大寫，以「駝峯」格式來處理；
(3)函數名應當說明函數的意圖和行爲。

3.變量：
(1)變量名只包含字母數字的字符，數字是容許的但大多數狀況下不鼓勵；
(2)變量名老是以小寫開頭，當變量名包含多個單詞，在首單詞後的全部單詞首字母大寫，以「駝峯」格式來處理

4.常量：
(1)常量包含數字字母字符和下劃線，數字容許做爲常量名;
(2)常量名的全部字母必須大寫;
(3)常量中的單詞必須如下劃線分隔

字符串
當字符串是文字(不包含變量)，應當用單引號來括起來
當文字字符串包含單引號就用雙引號括起來，特別在 SQL 語句中有用

字符串鏈接
字符串必需用 "." 操做符鏈接，在它的先後加上空格以提升可讀性

數組
索引不能爲負數，建議數組索引從0開始。
當用 array 函數聲明有索引的數組，在每一個逗號的後面間隔空格以提升可讀性
能夠用 "array" 聲明多行有索引的數組，在每一個連續行的開頭要用空格填補對齊
當用聲明關聯數組，array 咱們鼓勵把代碼分紅多行，在每一個連續行的開頭用空格填補來對齊鍵和值

類的聲明
花括號應當從類名下一行開始。
每一個類必須有一個符合PHPDocumentor標準的文檔塊。
類中全部代碼必需用四個空格的縮進。

類成員變量
變量的聲明必須在類的頂部，在方法的上方聲明。
不容許使用 var ，要用 private、 protected 或 public。直接訪問 public 變量是容許的但不鼓勵，最好使用訪問器（set/get）。

函數和方法聲明
在類中的函數必須用 private、 protected 或 public 聲明它們的可見性。
像類同樣，花括號從函數名的下一行開始。
函數名和括參數的圓括號中間沒有空格。
強烈反對使用全局函數。

函數和方法的用法
函數的參數應當用逗號和緊接着的空格分開
帶有數組參數的函數，函數的調用可包括 "array" 提示並能夠分紅多行來提升可讀性，同時，書寫數組的標準仍然適用

控制語句
if/else/elseif 使用 if and elseif 的控制語句在條件語句的圓括號先後都必須有一個空格。 在圓括號裏的條件語句，操做符必須用空格分開，鼓勵使用多重圓括號以提升在複雜的條件中劃分邏輯組合。
前花括號必須和條件語句在同一行，後花括號單獨在最後一行，其中的內容用四個空格縮進。

switch
在 "switch" 結構裏的控制語句在條件語句的圓括號先後必須都有一個單個的空格。 "switch" 裏的代碼必須有四個空格縮進，在"case"裏的代碼再縮進四個空格。

註釋
每一個類必須至少包含這些phpDocumentor標籤
每一個函數，包括對象方法，必須
有最少包含下列內容的文檔塊（docblock）：
函數的描述
全部參數
全部可能的返回值
由於訪問級已經經過 "public"、 "private" 或 "protected" 聲明。

命名規則

頭：header

內容：content/containe

尾：footer

姓名：name

帳號:id

密碼：password

收貨地址：address

電話號碼：phonenumber

管理員：admin

工做人員：stuff

用戶：user

時間：time

用戶帳號（手機號註冊）:user id

訂單: order

訂單信息（快遞短信）: message

工做人員工做號: staffs id

身份證號 : id number

黑名單 : blacklist

三.數據庫設計

User:用戶
User id:用戶帳號（手機號註冊）
Order:訂單
Message:訂單信息（快遞短信）
Name:姓名
Phone number:手機號
Address:用戶收貨地址
Staffs:工做人員
Staffs id:工做人員工做號
Id number:身份證號
Password:密碼
Blacklist:黑名單

四.團隊項目ER圖

五.主要功能流程描述

系統的總體框架

總體流程

代取快遞功能

投訴功能

工做人員註冊功能

工做人員業績查詢和管理功能

反饋功能

六.人員分工

七.小組成員得分狀況

楊然 10分 沈奇 10分 汪浩 10分 應靜 10分 韓英璨 10分 趙慧玲 10分