Java项目中可通过IDEA配置类头注释模板和方法Javadoc自动生成:在File and Code Templates中修改Class模板添加@author、@date、@description;通过/**+Enter或Alt+Enter一键生成方法注释,并用Live Template定制参数描述自动转换。

在Java项目中快速生成标准化的类头注释和方法Javadoc,避免每次手动敲写作者、日期、描述等重复内容,节省编码时间并统一团队文档风格。
为Java类自动生成带作者和日期的文件头注释
打开设置:按 Ctrl+Alt+S(Windows/Linux)或 Cmd+, (macOS),进入 Editor → File and Code Templates。
在左侧选择 Files 选项卡,在模板列表中找到 Class(加粗显示为内部模板),双击编辑其内容。
将默认模板替换为以下结构(保留原有 $CLASS_NAME$ 变量):
立即学习“Java免费学习笔记(深入)”;
/**
* @author $USER$
* @date $DATE$
* @description $DESCRIPTION$
*/
public class $CLASS_NAME$ {
}
【注意:$DESCRIPTION$ 变量需手动输入,IDEA不会自动填充,但光标会停在此处供你补全】
点击 Apply → OK。此后新建 Java 类时,文件头即自动包含作者名、当前日期与可编辑的描述占位符。
一键生成方法级Javadoc注释
方法一:快捷键触发(推荐)
在方法名上方空白行输入 /**,然后直接按 Enter —— IDEA 会自动识别下方方法签名,并生成含 @param、@return、@throws 的完整注释块。
方法二:Alt+Enter 快速插入
将光标置于方法名任意位置(如末尾),按 Alt+Enter,从弹出菜单中选择 Add Javadoc。
方法三:使用 Live Template
使用3×3×10框架生成90+个个性化Instagram内容创意,用AI编辑器精选最佳创意,并将获胜者扩展为可操作的简洁内容。
进入 Settings → Editor → Live Templates → Java → Documentation,确认 DocComment 模板已启用且适用范围为 Java method。输入 /** + Enter 即触发。
定制方法Javadoc模板,自动补全参数描述
第一步:进入 Live Templates 设置
按 Ctrl+Alt+S → Editor → Live Templates → 展开 Java 分组 → 点击 Documentation。
第二步:编辑 DocComment 模板
选中 DocComment,点击右侧 Edit variables。将 PARAM_DESC 的 Expression 改为 groovyScript("def result=''; def params='${_1}'; if(params) {result=params.replaceAll('\\W',' ').replaceAll(' +',' ').trim()}; result", methodParameters()) —— 这能让参数名自动转为中文风格描述(如 userId → user id)。
第三步:调整模板文本
将 Template text 修改为:
/**
* $DESCRIPTION$
*
#if($METHOD_PARAMS)$PARAM_NAME$ $PARAM_DESC$
#end
#if($RETURN_TYPE != 'void')* @return $RETURN_DESC$
#end
#if($EXCEPTIONS)* @throws $EXCEPTION$ $EXCEPTION_DESC$
#end
*/
第四步:应用并验证
点击 OK 保存。在任意方法上输入 /** + Enter,观察参数描述是否已按规则生成。

















