Eclipse 自動生成 Java 註解模板配置指南

Eclipse 自動生成 Java 註解模板配置指南

統一團隊代碼註解風格、減少手動輸入，Eclipse 內建的 Code Templates 功能可完美勝任。本文提供即用型模板配置，涵蓋類、欄位、建構子、方法、覆寫方法五大場景。

配置路徑

Window → Preferences → Java → Code Style → Code Templates → Comments

模板內容

Types（類/介面/枚舉）

/**
 * @author ${user} E-mail: ${user}@company.com
 * @date ${date} ${time}
 * @Description:
 * @version 1.0
 * ${tags}
 */

Fields（欄位）

/**
 * @Description: ${field}: ${todo}
 */

Constructors（建構子）

/**
 * @Description: ${todo}
 */

Methods（方法）

/**
 * @Description: ${todo}
 * @param ${param}
 * @return ${return}
 * @exception:
 */

Overriding Methods（覆寫方法）

/**
 * @Description: ${todo}
 * @param ${param}
 * @return ${return}
 * @exception:
 */

變數說明

• ${user}：系統登入用戶名
• ${date}、${time}：當前日期/時間
• ${tags}：自動生成的標籤（如 @param、@return）
• ${field}：欄位名稱
• ${param}、${return}：參數與返回值標籤
• ${todo}：佔位符，提醒開發者填寫具體描述

使用技巧

1. 配置後，新建類/方法時 Eclipse 自動插入對應註解骨架。
2. 若專案已有大量無註解代碼，可用 Source → Generate Element Comment 批量補全。
3. 團隊協作時，將 .settings/org.eclipse.jdt.core.prefs 納入版本控制，實現配置共享。
4. 進階：結合 Checkstyle 強制檢查註解完整性。

總結

花 5 分鐘配置模板，節省無數小時手寫註解時間，同時保證專案文檔風格統一。建議根據團隊規範微調模板內容後全員推廣。