Java 專案開發中,統一且語義清晰的命名規範是程式碼可讀性、可維護性的基石。核心原則:**優先使用英文單字,避免漢語拼音;採用駝峰命名法;名稱須表達業務含義。**
com.bjpowernode.test(對應 www.bjpowernode.com)com.bjpowernode.Test.javapackage 時屬於 default package,實務上應避免使用ConnectionFactory, UserServiceImpl, OrderControlleraddPerson, getUserById, calculateTotalAmountageOfPerson, userName, orderListis/has/can 開頭,如 isValid, hasPermission, fileExistspublic static final int MAX_RETRY_COUNT = 3;static final,語義完整表達業務常量| 建議 | 說明 | 正例 | 反例 |
|---|---|---|---|
| 語義化命名 | 名稱即文件,無需額外註解 | customerAge |
a, temp, data |
| 避免重複使用同一變數表達不同含義 | 單一職責原則應用於變數層級 | 分別宣告 startTime, endTime |
同一 time 先後存不同值 |
| 迴圈索引 | i, j, k 僅限小範圍簡單迴圈 |
for (int i = 0; i < 10; i++) |
巢狀迴圈或大範圍使用 |
| 避免 Flag 命名狀態變數 | 語義模糊,難以理解具體狀態 | isProcessing, hasError |
flag, status |
| 量詞後綴統一集合變數 | 便於理解與搜尋 | customerFirst, customerLast, customerCur |
firstCustomer, lastCustomer |
| 縮寫一致性 | 全專案統一縮寫規則或不縮寫 | 全用 count 或全用 cnt |
混用 intCnt 和 intCount |
0, 1 外,避免出現魔術數字NUM_DAYS_IN_WEEK, MAX_CONNECTION_POOL_SIZE良好的命名規範是團隊協作的溝通語言。建議專案啟動時制定命名標準文件,配合 IDE 格式化模板與靜態分析工具(如 Checkstyle、SonarQube)強制執行。命名即設計,名稱若難以取得簡潔明確,往往暗示著類別或方法職責不清,需重新審視設計。