Eclipse Java 代碼模板配置詳解：文件、類、方法、字段等常用註釋模板最佳實踐

模板配置入口

Eclipse 菜單：Window → Preferences → Java → Code Style → Code Templates，展開 Comments 節點即可看到所有可配置的註釋元素。

常用模板推薦配置

1. 文件註釋

/**
 * @Title: ${file_name}
 * @Package ${package_name}
 * @Description: ${todo}(用一句話描述該文件做什麼)
 * @author ${user}
 * @date ${date} ${time}
 * @version V1.0
 */

2. 類型註釋

/**
 * @ClassName: ${type_name}
 * @Description: ${todo}(這裡用一句話描述這個類的作用)
 * @author ${user}
 * @date ${date} ${time}
 * ${tags}
 */

3. 字段註釋

/**
 * @Fields ${field} : ${todo}(用一句話描述這個變量表示什麼)
 */

4. 構造函數註釋

/**
 * <p>Title: ${enclosing_type}</p>
 * <p>Description: 構造函數</p>
 * ${tags}
 */

5. 方法註釋

/**
 * @Title: ${enclosing_method}
 * @Description: ${todo}(這裡用一句話描述這個方法的作用)
 * @param ${tags} 參數說明
 * @return ${return_type} 返回類型
 * @throws 異常說明
 */

6. 覆蓋方法註釋

/* (非 Javadoc)
 * <p>Title: ${enclosing_method}</p>
 * <p>Description: </p>
 * ${tags}
 * ${see_to_overridden}
 */

7. Getter/Setter 註釋

/** @return ${bare_field_name} */          // Getter
/** @param ${param} 要設置的 ${bare_field_name} */ // Setter

導出/導入模板（XML 格式）

Eclipse 支持將模板導出為 XML 文件，團隊協作時可統一導入。關鍵屬性說明：

• context：模板適用上下文（如 filecomment_context、methodcomment_context）；
• autoinsert：是否自動插入；
• ${todo}：佔位符，生成時光標定位處，便於直接輸入業務描述。

變量模板示例（可直接導入）

<?xml version="1.0" encoding="UTF-8"?>
<templates>
  <template autoinsert="true" context="filecomment_context" ...>...</template>
  <template autoinsert="true" context="typecomment_context" ...>...</template>
  <template autoinsert="true" context="fieldcomment_context" ...>...</template>
  <template autoinsert="true" context="methodcomment_context" ...>...</template>
  ...
</templates>

最佳實踐建議

1. 統一團隊規範：導出 XML 納入版本控制，新成員導入即用；
2. ${todo} 佔位符善用：強迫開發者填寫業務含義，而非留空；
3. 保持輕量：避免在模板中放入過多固定文本，靈活利用 ${tags} 自動生成 @param、@return 等標簽；
4. 定期審視：隨項目演進調整模板，如新增模塊前綴、版本號規則等。

良好的註釋模板不僅能提升代碼可讀性，更能倒逼開發者養成「寫代碼前先想清楚職責」的習慣。