1. 程式人生 > 其它 >第五組-風雨五組-程式碼規範與衝刺計劃

第五組-風雨五組-程式碼規範與衝刺計劃

這個作業屬於哪個課程 至誠軟工實踐F班
這個作業要求在哪裡 第五次團隊作業:專案衝刺
這個作業的目標 規定程式碼規範,明確衝刺階段計劃與目標

一、程式碼規範

(一)命名風格

  • 所有程式設計相關的命名均不能以下劃線或美元符號開始,也不能以下劃線或美元符號結束。

  • 所有程式設計相關的命名嚴禁使用拼音與英文混合的方式,更不允許直接使用中文的方式。

  • 方法名、引數名、成員變數、區域性變數都統一使用 lowerCamelCase 風格(駝峰命名法)。

  • 常量命名應該全部大寫,單詞間用下劃線隔開,力求語義表達完整清楚,不要嫌名字長。

  • 避免在子父類的成員變數之間、或者不同程式碼塊的區域性變數之間採用完全相同的命名,使可理解性降低。

  • 杜絕完全不規範的英文縮寫,避免望文不知義。

(二)程式碼格式

  • 若函式或過程中的引數較長,則要進行是適當的劃分。

  • 註釋的雙斜線與註釋內容之間有且僅有一個空格。

  • 方法引數在定義和傳入時,多個引數逗號後面必須加空格。

  • 程式塊要採用縮排風格編寫,縮排的空格數為4個,避免使用Tab進行縮排。

  • 較長的語句(>80字元)要分成多行書寫,長表示式要在低優先順序操作符處劃分新行,操作符放在新行之首,劃分出的新行要進行適當的縮排,使排版整齊,語句可讀。

  • 迴圈、判斷等語句中若有較長的表示式或語句,則要進行適應的劃分,長表示式要在低優先順序操作符處劃分新行,操作符放在新行之首。

  • 不允許把多個短語句寫在一行中,即一行只寫一條語句。

  • if、for、do、while、case、switch、default等語句自佔一行,且.if、for、do、while等語句的執行語句部分無論多少都要加括號{}.

(三)註釋規約

  • 類、類屬性、類方法的註釋必須使用 Javadoc 規範,使用 /** 內容 */ 格式,不得使用 // xxx方式。

  • 所有的抽象方法(包括介面中的方法)必須要用 Javadoc 註釋、除了返回值、引數異常說明外,還必須指出該方法做什麼事情,實現什麼功能。

  • 方法內部單行註釋,在被註釋語句上方另起一行,使用 // 註釋。方法內部多行註釋使用 /* */註釋,注意與程式碼對齊。

  • 程式碼修改的同時,註釋也要進行相應的修改,尤其是引數、返回值、異常、核心邏輯等。

  • 好的命名、程式碼結構是自解釋的,註釋力求精簡準確、表達到位。避免出現註釋的另一個極端:過多過濫的註釋,程式碼的邏輯一旦修改,修改註釋又是相當大的負擔。

  • 選擇熟悉的、可以正確表達程式碼含義的語言進行註釋,不必追求英文註釋。

(四)可讀性

  • 注意運算子的優先順序,並用括號明確表示式的操作順序,避免使用預設優先順序。

  • 避免使用不易理解的數字,用有意義的標識來替代。

  • 源程式中關係較為緊密的程式碼應儘可能相鄰。

二、預期計劃

計劃天數 任務進度
第1天 進行小組會議,分配任務,明確個人分工
第2-3天 前端完成基礎頁面設計
後端完成各模組程式碼
第4-5天 前端完成頁面跳轉及元件功能實現
後端補足各模組缺失介面程式碼
第6-8天 前端進行UI統一及美化介面
後端測試並完善基礎功能介面
第9-10天 前端呼叫後端介面,完成效果呼叫
後端輔助前端完成呼叫,進行相應的修改
第11天 前端測試、後端根據測試,修改並完善功能
第12天 收尾工作,驗收最後成功、Bug修改和後期維護

三、預期目標

序號 功能點 功能實現 備註
1 登入 使用者登入 密碼登入或微信登入
2 釋出 釋出訂單 正常釋出
3 接受 接受訂單 正常接受
4 搜尋 搜尋特定訂單
5 取消 取消訂單 正常取消
6 註冊 註冊賬號 正常註冊
7 退出 退出登入 正常退出
8 設定 繫結郵箱、重置密碼 成功繫結郵箱、正常重置密碼