Eclipse 代碼模板與 Javadoc 模板配置全攻略

Eclipse 代碼模板與 Javadoc 模板配置全攻略

一、代碼模板

1.1 設置路徑

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

重點配置 Types、Methods 模板：

/**
 * @author attilax
 * ${date} ${time}
 * ${tags}
 */

1.2 存儲位置

${workspace}/.metadata/.plugins/org.eclipse.core.runtime/.settings/org.eclipse.jdt.ui.prefs

1.3 導出/導入

導出 CodeTemplates.xml，團隊共享統一風格。片段示例：

<template autoinsert="false" context="typecomment_context" ...>
/**
 * @author attilax
 * ${date} ${time}
 * ${tags}
 */</template>

二、Javadoc 智能提示模板

2.1 編輯入口

Preferences → Java → Editor → Templates → New

新建 @author 模板：

@author attilax ${date} ${time}

2.2 導出文件

Templates.xml，內容示例：

<?xml version="1.0" encoding="UTF-8"?>
<templates>
  <template autoinsert="true" context="javadoc" ... name="@author">
    @author attilax ${date} ${time}
  </template>
</templates>

三、變量說明

• ${date}、${time}：當前日期/時間；
• ${user}：系統用戶名；
• ${tags}：標簽佔位；
• 更多內置變量見 Eclipse 官方文檔。

四、最佳實踐

• 項目級 .settings 提交版本庫，保證團隊風格統一；
• 結合 Checkstyle / SpotBugs 強制檢查；
• 定期更新模板適配新版本 JDK/Javadoc 標簽。