Java 編碼規範全攻略：命名、註釋、文件結構與最佳實踐

Java 編碼規範全攻略：命名、註釋、文件結構與最佳實踐

1. 命名約定

原則：完整英文、領域術語、混合大小寫、<15 字符、避免相似名、少用縮寫、除常量外禁用下劃線。

2. 註釋約定

• 文檔註釋：類/接口/方法/字段前，/** ... */，說明「做什麼、為什麼、參數、返回、異常」；
• C 風格：/* ... */ 臨時屏蔽代碼，註明作者、日期、保留原因；
• 單行：// 方法內說明業務邏輯、暫存變量；
• 原則：先寫註釋再寫碼、解釋「為什麼」而非「做什麼」、保持簡潔。

3. 文件結構順序

1. 版權聲明
2. package / import（標準包前、按字母序、* 合併子包）
3. 類文檔註釋 + 類定義（extends/implements 分行）
4. 字段（public 需 javadoc）
5. 存取方法（簡單 getter/setter 可單行）
6. 構造器（參數少→多）
7. clone 方法
8. 業務方法
9. toString()
10. main() 測試入口（可選，置底）

4. 格式細節

• 縮進 2 空格，禁用 Tab；
• 行寬 80 字符，超長在逗號/運算符後換行並再縮進 2 格；
• { 獨佔一行，} 獨佔一行；
• 括號緊貼內容：method(arg) 而非 method( arg )；
• JSP 命名：動詞開頭 camelCase（viewMessage.jsp）；Servlet 類：XxxService。

5. 編程建議

• 拼接字符串用 StringBuilder 避免臨時對象；
• 最小化 synchronized 範圍，塊級鎖優於方法鎖；
• 避免 Vector（同步開銷），優先 ArrayList + 手動同步或並發集合；
• 面向接口編程：返回 List 而非 ArrayList；
• 結果集按列名而非索引訪問，屏蔽 SQL 變更影響。

參考：阿里巴巴 Java 開發手冊精華