Java 代碼開發規範全攻略：工具、排版、命名、註釋與日誌標準

一、開發工具規範

1. 統一 IDE（如 IntelliJ IDEA / Eclipse），由項目負責人確認後全組使用。
2. 禁止私自安裝非統一插件；如有需求，經負責人批准後統一分發。
3. 編碼格式（UTF-8）不得隨意修改。

二、排版與格式規範

三、命名規範

1. 包名

全小寫，單詞連寫：com.company.project.module

2. 類名

PascalCase：DatabaseOperator、UserServiceImpl

3. 變量/方法

camelCase：userName、getUserById()

4. 常量

全大寫 + 下劃線：MAX_RETRY_COUNT、DB_CONFIG_FILE_PATH

5. 數組聲明

byte[] buffer;（推薦），而非 byte buffer[];

6. 分頁參數

每頁條數 pageSize，當前頁碼 pageNumber

四、註釋規範

• 原則：邊寫邊註，代碼修改同步更新註釋；註釋就近原則，內容準確無歧義。
• 變量/常量：放在上方或行尾，不放下方。
• 全局變量：需詳細說明用途、取值範圍、訪問者及注意事項。
• 類/方法/成員：強制使用 Javadoc（/** ... */），Eclipse/IDEA 輸入 /** 回車自動生成模板。
• 類文檔標籤：@author、@version、@see、@param、@return、@exception、@modify（多次修改追加）。
• 方法內部邏輯：由開發者根據複雜度自行添加行內註釋。

五、基本數據類型前綴表

六、日誌組件規範

• log.debug()：調試信息，放在代碼關鍵節點，永久保留不刪除。
• log.error()：僅用於 catch 塊中記錄異常堆棧與上下文。
• 嚴禁使用 System.out.println 替代日誌。

總結

統一規範是團隊協作高效、代碼可維護性強的基石。建議將本文檔納入項目《開發手冊》，配合 Checkstyle / SpotBugs / SonarQube 等工具在 CI 流程中自動檢查，從源頭保證代碼風格一致。