先了解一下idea自定义文档注释模板
IntelliJ IDE --> Preferences --> Editor --> File and Code Templates --> Includes --> File Header
/**
* ClassName: ${NAME} <br/>
* Description: <br/>
* date: ${DATE} ${TIME}<br/>
* @author ${USER}<br/>
* @version
* @since JDK 1.8
*/
2 方法注释
IntelliJ IDE --> Preferences --> Setting --> Editor --> LiveTemplates
-
绿色的+号,选择Template Group双击 新建的Template Group eg:MyGroup
-
选择MyGroup,再次点击右面的加号,选择第一个选项 live Template
注意:addrebiation :快捷键 -
设置change 选中 java相关(否则快捷键无效)
复制代码
/**
- Description:
- @author:
U
S
E
R
USER
USER
- @date:
D
A
T
E
DATE
DATE
T
I
M
E
TIME
TIME
- @param:
p
a
r
a
m
param
param
- @return:
r
e
t
u
r
n
return
return
*/
复制代码
变量定义
user --> user()
date–>date()
time–>time()
param–>methodParameters()
return–>methodReturnType()
生成文档:
记得在 Other Command line arguments:出填写 -encoding utf-8 -charset utf-8否则会出现乱码
这样就生成了api了