define coding style for developer team

1. Java Coding Style
Davis Chen

2. Outline
•Why we need
•Important thing
•Naming conventions
•Enum
•Constant
•Utils
•Javadoc

3. Why we need
•Coding is teamwork !
•可讀性
•避免技術債
•壞味道

4. Important thing
•可讀性是最重要的 !!!
◆可讀性是最重要的 !!!
✦可讀性是最重要的 !!!
• 規範不是拿來攻擊的武器

5. Naming conventions
•駝峰式命名
•避免 a,b,c,x,y,z ...
•注意大小寫
•不知道怎麼命名？
1. 參考舊有的 code
2. 跟同事討論
3. google 一般通則

6. Enum
•多個類型、狀態、屬性
◆ex 產品類型、審核狀態
•數值使用的時機 >0 , 0 ,<0
◆ex 啟用 1 , 上線 2 , 停用 0 , -1退回
•is() , equal() function
◆避免 int a ;
if (a == XXType.Atype.getValue())

7. Constant
•會隨環境改變的放 properties
•全部大寫
◆ex String DATE_FORMAT_DASH = “XXX”
•與 Utils 的搭配

8. Utils
•空值、NULL判斷
•多使用 apache common utils ,open utils
•需要轉換、比對、共用
•客製化方法需多說明

9. Javadoc
•method 的說明
•utils 需要附上範例
•參考資料使用 @see
•利用 IDE 自動生成

10. THE END
~~ Thanks for your listening ~~