團隊作業第五次——站立式會議+alpha沖刺

這個作業屬于哪個課程	班級的連結
這個作業要求在哪裡	作業要求的連結
這個作業的目标	沖刺前随筆
作業正文	如下
其他參考文獻	阿裡巴巴Java開發手冊終極版v1.3.0

一、代碼規範

命名規則

• 嚴禁使用拼音與英文混合的方式，更不允許直接使用中文的方式。
• 任何自定義程式設計元素在命名時，使用盡量完整的單詞、組合來表達其意。
• 類名使用 UpperCamelCase 風格，必須遵從駝峰形式.
• 若子產品、接口、類、方法使用了設計模式，在命名時展現出具體模式。
• 包名統一使用小寫，點分隔符之間有且僅有一個自然語義的英語單詞。包名統一使用單數形式，但是類名如果有複數含義，類名可以使用複數形式。
• POJO 類中布爾類型的變量，都不要加 is，否則部分架構解析會引起序列化錯誤。
• 對于 Service和DAO 類，基于SOA的理念，暴露出來的服務一定是接口，内部 的實作類用 Impl 的字尾與接口差別。

  例如：CacheServiceImpl 實作 CacheService 接口。

• DAO 層方法命名規約
  1. 擷取單個對象的方法用 get 做字首
  2. 擷取多個對象的方法用 list 做字首
  3. 擷取統計值的方法用 count 做字首
  4. 插入的方法用 save/insert 做字首
  5. 删除的方法用 remove/delete 做字首
  6. 修改的方法用 update 做字首

常量定義

• 常量命名采用全大寫的方式,必要時添加注釋
• 不允許任何未經定義的常量直接出現在代碼
• 不要使用一個常量類維護所有常量，按常量功能進行歸類，分開維護。
• long 或者 Long 初始指派時，使用大寫的 L，不能是小寫的 l，小寫容易跟數字1混淆造成誤解

代碼格式

• 縮進：采用4個空格縮進，若使用tab縮進，則必須将設定一個tab為4個空格
• 空格規則：
  1. if/for/while/switch/do 等保留字與括号之間都必須加空格
  2. 任何二目、三目運算符的左右兩邊都需要加一個空格
  3. 沒有必要增加若幹空格來使某一行的字元與上一行對應位置的字元對齊
• 空行規則：
  1. 兩個方法之間
  2. 方法内的局部變量和方法的第一條語句之間
  3. 塊注釋或單行注釋之前
  4. 一個方法内的兩個邏輯段之間

OOP規則

• 避免通過一個類的對象引用通路此類的靜态變量或靜态方法，直接用類名來通路
• 不能使用過時的類或方法
• 所有的覆寫方法，必須加@Override 注解
• 關于基本資料類型與包裝資料類型的使用标準如下：
  1. 所有的 POJO 類屬性必須使用包裝資料類型。
  2. RPC 方法的傳回值和參數必須使用包裝資料類型。
  3. 所有的局部變量使用基本資料類型。
• 構造方法裡面禁止加入任何業務邏輯，如果有初始化邏輯，請放在 init 方法中
• 當一個類有多個構造方法，或者多個同名方法，這些方法應該按順序放置在一起， 便于閱讀

注釋規則

• 類、類屬性、類方法的注釋必須使用/**内容*/格式,不得使用 // xxx 方式
• 方法内部單行注釋，在被注釋語句上方另起一行，使用//注釋。方法内部多行注釋 使用/* */注釋，注意與代碼對齊
• 代碼修改的同時，注釋也要進行相應的修改，尤其是參數、傳回值、異常、核心邏輯 等的修改
• 重要函數頭部應該注釋，解釋函數功能、參數和傳回值等；注釋的内容應該清楚明了；避免非必要的注釋

二、沖刺任務與計劃