Intellij idea 注释模版

Intellij idea 注释模版

背景

每次新环境设置java的class、method、field注释模版都要折腾会,这会趁着这次机会记录下便于后续参考。

场景

  1. 新建java类自动生成class注释模版(无需用户干预)
  2. 已建java类自动生成class注释模版(classdoc+Enter,classdoc为自己自定义创建的Live Template名称)
  3. java类属性注释模版(fielddoc+Enter)
  4. java类方法注释模版(/**+Enter自动补全)

效果

  • 设置模版
java 复制代码
/**
 * 创建者:  shouzhi
 * 创建时间: 2025-11-15 17:20
 * 项目名称: spring-boot-test
 * 文件名称: com.test.TestClass.java
 * 公司名称: NVXCLOUDS TECH
 * 描述信息: 注释模版测试类
 * <p>
 * All rights Reserved, Designed By NvxClouds Tech
 * </p>
 * Copyright: 2025
 */
public class TestClass {

    /**
     * @Author shouzhi
     * 字段描述:用户姓名
     * 使用提示:不能为空
     **/
    private String name;

    /**
     * @Author shouzhi
     * 字段描述:用户年龄
     * 使用提示:不能为空
     **/
    private int age;

    /**
     * @Author shouzhi
     * @Description TODO
     * @Date 2025-11-15 17:22
     * @Param  [name, age]
     * @return java.lang.String
     **/
    private String getUser(String name, int age){
        return  name + " " + age;
    }

}

设置

新建java类自动生成class注释模版

java 复制代码
/**
 * 创建者:  shouzhi
 * 创建时间: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
 * 项目名称: ${PROJECT_NAME}
 * 文件名称: ${PACKAGE_NAME}.${NAME}.java
 * 公司名称: NVXCLOUDS TECH
 * 描述信息: TODO
 * <p>
 * All rights Reserved, Designed By NvxClouds Tech
 * </p>
 * Copyright: ${YEAR}
*/

这样每次新建的java类头部就会自动加上如上的注释

已建java类自动生成class注释模版

java 复制代码
/**
 * 创建者: shouzhi
 * 创建时间: $DATE$ $TIME$
 * 项目名称: $PROJECT_NAME$
 * 文件名称: $FULL_CLASS$
 * 公司名称: NVXCLOUDS TECH
 * 描述信息: TODO
 * <p>
 * All rights Reserved, Designed By Nvxclouds Tech
 * </p>
 * Copyright: $YEAR$
 */
java 复制代码
FULL_CLASS:groovyScript("def file=com.intellij.openapi.fileEditor.FileEditorManager.getInstance(com.intellij.openapi.project.ProjectManager.getInstance().getOpenProjects()[0]).getSelectedFiles()[0]; if(file==null)return ''; def path=file.getPath(); def idx=path.indexOf('/src/main/java/'); if(idx==-1)idx=path.indexOf('/src/test/java/'); if(idx==-1)return file.getName(); def pkgPath=path.substring(idx+14).replace('/','.').replace('.java',''); pkgPath=pkgPath.replaceAll('^[.]+',''); return pkgPath+'.java'")

PROJECT_NAME:groovyScript("_editor.getProject().getName()")

在类头上输入:classdoc+Enter自动生成类的注释模版

java类属性注释模版

java 复制代码
/**
 * @Author shouzhi
 * @Date $DATE$ $TIME$
 * 字段描述:
 * 使用提示:
 **/

在属性上输入:fielddoc+Enter自动生成属性的注释模版

java类方法注释模版

java 复制代码
// ⚠️下面第一个*号和后面的所有*号一定要按照下面的方式对齐,否则生成的模版第一行的效果是:/* *多了一个空格。正确的第一行是/**。
*
 * @Author shouzhi
 * @Description TODO
 * @Date $DATE$ $TIME$
 * @Param  $param$
 * @return $return$
 **/

在方法上输入:/**+Enter自动生成方法的注释模版

相关推荐
特立独行的猫A6 小时前
别再用 nohup 了:让应用在后台常驻的正确姿势与 systemd 服务详解
java·后端·python
一起_java7 小时前
技术文章-基于Dify-Agent的智能问答系统设计与实现
java·spring boot·后端·agent·dify
Flynn Liang8 小时前
I/O 密集型高并发实战:Java 服务 10 维优化,从线程打满到 10 万 QPS
java·spring boot·性能优化·高并发·系统设计·虚拟线程·io密集型
吃我一窝jio9 小时前
Python与Go线程模型深度对比
java·开发语言·python
这个昵称不容易9 小时前
SpringBoot 购物推荐网站的设计与实现:120 个 Java 文件、147 个接口、13 张表,附真实运行截图
java·springboot·毕设
文丑颜不良啊9 小时前
LeetCode3041~3060题目解析
java·leetcode
zwd200510 小时前
Manim 怎么放大画面的某一部分?
python·动画·可视化·manim·数学动画
屿华AI10 小时前
AUTOSAR 实战-诊断工具 | UDS 0x27 安全访问的配置化实现:种子密钥算法插件化设计
python·测试工具·汽车
RobinDevNotes11 小时前
Claude Code 剪视频,不上传、不要 API Key
人工智能·python·音视频·开发工具·ipython
文丑颜不良啊11 小时前
LeetCode3101~3120题目解析
java·leetcode