程式碼註解規範與快捷鍵
各語言註解語法
| 語言 | 單行註解 | 多行註解 | 文檔註解 |
| HTML | -- | <!-- 註解 --> | -- |
| CSS | -- | /* 註解 */ | -- |
| JavaScript | // 註解 | /* 註解 */ | /** JSDoc */ |
| Java | // 註解 | /* 註解 */ | /** Javadoc */ |
Eclipse 註解快捷鍵
- Ctrl + /:切換單行註解(
//)
- Ctrl + Shift + /:新增多行註解(
/* */)
- Ctrl + Shift + \:移除多行註解
- Alt + Shift + J:為方法/類/欄位生成 Javadoc 模板
註解撰寫最佳實踐
- 類/介面:說明職責、作者、版本、建立日期
- 方法:功能描述、參數說明、返回值、拋出異常、副作用、範例
- 欄位:業務含義、取值範圍、單位
- 複雜邏輯:演算法思路、為什麼這樣寫、參考連結
- TODO/FIXME:標記待辦/已知問題,IDE 會收集顯示
/**
* 計算複利收益
*
* @param principal 本金 (元)
* @param rate 年利率 (如 0.035 代表 3.5%)
* @param years 投資年限
* @return 本利和 (元),保留兩位小數
* @throws IllegalArgumentException 參數為負數時拋出
* @since 1.2.0
*/
public BigDecimal calculateCompoundInterest(BigDecimal principal, double rate, int years) {
// 參數驗證
if (principal.compareTo(BigDecimal.ZERO) < 0 || rate < 0 || years < 0) {
throw new IllegalArgumentException("參數不能為負數");
}
// 核心演算法:FV = PV × (1 + r)^n
// 使用 BigDecimal 避免浮點數精度損失
...
}
Eclipse/MyEclipse 核心快捷鍵分類速查
編輯操作
| 快捷鍵 | 功能 | 適用場景 |
| Ctrl + D | 刪除當前行 | 快速清理代碼 |
| Ctrl + Alt + ↓/↑ | 複製當前行到下/上一行 | 重複代碼块 |
| Alt + ↓/↑ | 當前行與下/上行交換 | 調整語句順序 |
| Ctrl + Shift + X/Y | 選中文字轉大/小寫 | 常數命名轉換 |
| Ctrl + Shift + F | 格式化代碼 | 統一風格 |
| Ctrl + 1 | 快速修復/建議 | 導入類、生成方法、修正錯誤 |
| Alt + / | 內容輔助(代碼補全) | 輸入提示 |
導航與搜尋
| 快捷鍵 | 功能 |
| Ctrl + Shift + T | 打開類型(類/介面/Enum) |
| Ctrl + Shift + R | 打開資源(檔案) |
| Ctrl + O | 快速 Outline(當前類結構) |
| F3 | 跳轉到宣告 |
| Ctrl + T | 快速型別繼承結構 |
| Ctrl + Shift + G | 工作區搜尋引用 |
| Ctrl + G | 工作區搜尋宣告 |
| Ctrl + L | 跳轉到指定行號 |
| Ctrl + Q | 回到最後編輯位置 |
重構操作 (Alt + Shift 開頭)
| 快捷鍵 | 功能 |
| Alt + Shift + R | 重命名(變數/方法/類/套件) |
| Alt + Shift + M | 提取方法 |
| Alt + Shift + L | 提取區域變數 |
| Alt + Shift + F | 區域變數轉欄位 |
| Alt + Shift + I | 內聯(移除方法/變數) |
| Alt + Shift + C | 修改方法簽名 |
| Alt + Shift + Z | 復原重構 |
除錯操作
| 快捷鍵 | 功能 |
| F5 | 單步進入 |
| F6 | 單步跳過 |
| F7 | 單步返回 |
| F8 | 繼續執行 |
| Ctrl + Shift + B | 切換斷點 |
| F11 | 除錯上次啟動 |
| Ctrl + F11 | 執行上次啟動 |
視窗與視圖管理
- Ctrl + F6 / Ctrl + Shift + F6:切換編輯器(下一個/上一個)
- Ctrl + F7 / Ctrl + F8:切換視圖/透視圖
- Ctrl + M:最大化/還原當前編輯器
- Ctrl + E:開啟編輯器下拉清單
- Ctrl + F10:顯示視圖選單
效率提升建議
- 肌肉記憶:優先掌握高頻 10-15 個快捷鍵
- 自訂綁定:
Window → Preferences → Keys 解決衝突(如 Ctrl + Space 與輸入法)
- 鍵盤圖:列印官方快捷鍵圖表貼在工位
- 發布前清理:上線前移除調試註解、壓縮 JS/CSS,減少頻寬