企業級 Java 代碼開發規範（WISHSOFT 標準版）
統一的代碼風格能顯著降低維護成本、提升團隊協作效率。本規範涵蓋開發工具、排版佈局、命名慣例、註釋標準、基礎型別前綴、Log4j 日誌用法六大維度，作為專案組強制執行基準。
一、開發工具規範
- IDE 由專案負責人統一確定（建議 IntelliJ IDEA / Eclipse 統一版本）。
- 禁止私自安裝非統一插件；確有需要經負責人批准後統一分發。
- 編碼格式（UTF-8）、換行符（LF）嚴禁修改。
二、排版佈局規範
- 關鍵字/變數與運算符間加一空格：
int i = 1;
- 邏輯獨立代碼塊間加空行（如方法之間）。
- 長語句/表達式拆分多行，低優先級運算符換行且置行首。
- 縮進使用 Tab 鍵，層級分明。
- 一行僅寫一條語句；禁止多短語句同行。
- 大括號
{ } 各佔一行，與引用語句左對齊（K&R 風格）。
main 方法置於類底部。
三、命名規範
| 元素 | 規則 | 範例 |
|---|
| Package | 全小寫單詞 | com.wish |
| Class/Interface | PascalCase，每單詞首字母大寫 | DatabaseOperator |
| 實例/區域變數 | camelCase，首字母小寫 | userName, size |
| 常量 (static final) | 全大寫 + 下劃線 | DB_CONFIG_FILE_PATH |
| 方法 | camelCase，動詞開頭 | setName(), getMethod() |
| 參數 | camelCase，盡量與賦值欄位同名 | public void setSize(int size) |
| 陣列 | type[] name 而非 type name[] | byte[] buffer; |
| 分頁參數 | 固定命名 | pageSize, pageNumber |
四、註釋規範
- 簡潔明確；代碼修改同步更新註釋。
- 必要處註釋，避免過度/不足；就近原則。
- 變數/常量註釋置上方或右側，不置下方。
- 全域變數須詳註：功能、取值範圍、存取點、注意事項。
- 類、方法、欄位強制生成 Javadoc（含 Entity 的 getter/setter）。
- Eclipse/IDEA 輸入
/** 回車自動生成模板，首行必填功能描述。
類級 Javadoc 標籤
/**
* 功能描述
* @author lifw 20080320
* @modify lifw 20080321 (多個 @modify 依序)
* @copyright wishsoft
*/
常用 Javadoc 標籤
| 標籤 | 用於 | 說明 |
|---|
| @author | 類 | 作者 |
| @version | 類 | 版本號 |
| @see | 類/屬性/方法 | 參考關聯 |
| @param | 方法 | 參數說明 |
| @return | 方法 | 返回值說明 |
| @exception | 方法 | 拋出異常說明 |
五、基礎資料型別前綴對照表
| Java 型別 | 前綴 |
|---|
| int | i |
| String | str |
| char | c |
| long | l |
| float | f |
| double | d |
| boolean | b |
| short | s |
| byte | by |
| Vector/List | v |
其他型別隨專案補充，統一納入團隊字典。
六、Log4j 日誌組件使用規範
log.debug()：置於代碼邏輯中間，調試輸出，**永久保留，不得刪除**。log.error()：置於 catch 區塊，記錄異常堆疊與關鍵上下文。- 禁止使用
System.out.println 替代日誌。
- 生產環境 Root Logger 級別設為
ERROR；開發環境可設 DEBUG。
規範非束縛，而是團隊高效協作的基石。建議接入 Checkstyle/SpotBugs + CI 檢查，落地執行。
