Idea自定义文档注释模板

/**

在idea中,您可以通过输入/**并按enter键快速生成模板注释。

那么如何设置模板内容呢?

一、自定义类文档注释模板

操作步骤

File–> Settings–>Editor–> File and Code Templates –> Includes –> File Header–> 粘贴模板内容

图示

需要粘贴的内容

模板内容

/**
* ClassName: ${NAME} <br/>
* Description: <br/>
* date: ${DATE} ${TIME}<br/>
* @author ${USER}<br/>
* @version
* @since JDK 11
*/

${USER} 也可以直接替换成你的姓名

二、自定义方法文档注释模板

操作步骤

File–> Settings–>–> Editor –> LiveTemplates

1) 点击右边的+号,选择Template Group点击 新建的Template Group 输入:NewGroup

2) 选择NewGroup,点击右面的加号,选择 live Template

在Addrebiation 中输入 /**

3) 设置change 选中 java相关(否则快捷键无效)

4)快捷键设置成Enter

图示

/**
* Description: <br/>
* @author: $USER$<br/>
* @date: $DATE$ $TIME$<br/>
* @param:$param$<br/>
* @return:$return$
*/

user --> user()
date-->date()
time-->time()
param-->methodParameters()
return-->methodReturnType()
测试

新建一个类会自动添加文档注释

在方法内 输入/** 按 Enter会生成方法文档注释

资源下载: