惯性聚合 高效追踪和阅读你感兴趣的博客、新闻、科技资讯
阅读原文 在惯性聚合中打开

推荐订阅源

Martin Fowler
Martin Fowler
有赞技术团队
有赞技术团队
博客园_首页
H
Help Net Security
GbyAI
GbyAI
aimingoo的专栏
aimingoo的专栏
V
Visual Studio Blog
The Cloudflare Blog
腾讯CDC
Jina AI
Jina AI
Last Week in AI
Last Week in AI
月光博客
月光博客
博客园 - 叶小钗
Google DeepMind News
Google DeepMind News
B
Blog RSS Feed
Blog — PlanetScale
Blog — PlanetScale
人人都是产品经理
人人都是产品经理
Engineering at Meta
Engineering at Meta
Y
Y Combinator Blog
Hugging Face - Blog
Hugging Face - Blog
博客园 - 聂微东
爱范儿
爱范儿
N
Netflix TechBlog - Medium
F
Fortinet All Blogs

博客园 - nuccch

在Cursor中读取飞书文档 使用GIMP去除水印的有效方法 如何基于VSCode打造Java开发环境 在Windows中使用Linux系统 树形层级结构的数据库表设计方案 如何理解和认识设计模式 申请Let's Encrypt免费HTTPS证书的方法 为GIT仓库项目设置独立配置参数 DBeaver设置不断开连接 构建工具Gradle入门实践 如何在Maven中排除依赖传递 87键键盘的数字键对应快捷键含义 关于Java JSON库的选择 解决mybatis批量更新慢问题 解决Spring Cloud Gateway中使用CompletableFuture.supplyAsync()执行Feign调用报错 Spring Boot框架中在Controller方法里获取Request和Response对象的2种方式 解读Spring Boot框架中不同位置抛出异常的处理流程 探究Spring Boot框架中访问不存在的接口时触发对error路径的访问 Spring Cloud工程中使用Nacos配置中心的2种方式 Swagger开启账号验证访问
在IDEA中配置注释模板
nuccch · 2026-03-14 · via 博客园 - nuccch

为了统一项目代码规范,要求大家都统一Java类和方法注释,如下:

类注释格式:

/**
 * <p>描述:${DESCRIPTION}</p>
 *
 * @author ${USER}
 * @date ${DATE} ${TIME}
 * @version 1.0
 */

方法注释格式:

/**
 * TODO: 方法功能描述
 * @author ${USER}
 * @since $date$ $time$
 * @param $param$
 * @return $return$
 */

在IDEA中可以分别添加如下类注释模板和方法注释模板:

配置路径:Editor > Live Templates

第一步:新建Template Group,命名为:ccc(也可以命名为其他任意名称)
第二步:在上一步新建的Template Group中新建Live Template

新建类注释模板:
Abbreviation:ccc(也可以指定其他任意字符,就是一个快速添加注释的缩写)
Description:类注释模板
Template text:

/**
 * <p>描述:${DESCRIPTION}</p>
 * @author $USER$
 * @date $DATE$
 * @version 1.0
 */

变量值:
USER:可以为固定值,也可以使用表达式取值,如:admin(固定值),user()(表达式取值)。
DATE:date("yyyy.MM.dd HH:mm:ss")

应用范围:Java -> Declaration
类注释

在需要添加注释的类名上面输入:ccc + TAB就可以快速添加类注释。

新建方法注释模板:
Abbreviation:*(只能用星号,不能用其他字符)
Description:方法注释模板
Template text:

*
 * TODO: 方法功能描述
 * @author $USER$
 * @since $DATE$
$PARAMS$
 * @return
 */

变量值:
USER:可以为固定值,也可以使用表达式取值,如:admin(固定值),user()(表达式取值)。
DATE:date("yyyy.MM.dd HH:mm:ss")
PARAMS:

groovyScript("def params = _1; if (params == null || params.isEmpty()) return ''; def result = ''; for (i = 0; i < params.size(); i++) { result += ' * @param ' + params[i] + (i < params.size() - 1 ? '\\n' : '') }; return result", methodParameters())

应用范围:Java -> Comment
方法注释

在需要添加注释的方法名上面输入:/** + TAB快速添加方法注释。