IntelliJ IDEA生成JavaDoc注释与类模板设置

冬枫同学_7059

冬枫同学_7059

2026-08-14

320人浏览

原创

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

intellij idea生成javadoc注释与类模板设置

在Java项目中快速生成标准化的类头注释和方法Javadoc,避免每次手动敲写作者、日期、描述等重复内容,节省编码时间并统一团队文档风格。

为Java类自动生成带作者和日期的文件头注释

打开设置:按 Ctrl+Alt+S(Windows/Linux)或 Cmd+, (macOS),进入 Editor → File and Code Templates。

在左侧选择 Files 选项卡,在模板列表中找到 Class(加粗显示为内部模板),双击编辑其内容。

将默认模板替换为以下结构(保留原有 $CLASS_NAME$ 变量):

/**

* @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

进入 Settings → Editor → Live Templates → Java → Documentation,确认 DocComment 模板已启用且适用范围为 Java method。输入 /** + Enter 即触发。

Instagram Content Ideas Generator
Instagram Content Ideas Generator

使用3×3×10框架生成90+个个性化Instagram内容创意,用AI编辑器精选最佳创意,并将获胜者扩展为可操作的简洁内容。

下载

定制方法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,观察参数描述是否已按规则生成。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

java idea intellij idea

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

12197

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

9302

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

7932

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1284

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

1028

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1536

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

3189

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

20451

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1395

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习