一、类注释
每次重新安装IDEA过后,都要设置一下快捷注释方式,而设置细节总是落下,这里记录一下,方便回头查看。
1. 修改类头的文档注释信息
模板内容如下:
/**
@Author: xj0927
@Description:
@Date Created in ${YEAR}-${MONTH}-${DAY} ${TIME}
@Modified By:
*/
直接在右边的文件框里编辑你说需要注释的东西,然后应用保存之后,当你创建类的时候就会自动生成注释。
二、方法注释
1)要求效果:
**
* @Description: 添加你要描述的内容~~
* @Param: [a,b,c,d]
* @Return:
* @Author: xj0927
* @Date Created in 2020/08/19 11:37
*/
2)具体实现步骤:
1、打开系统设置Setting(Ctrl+Alt+S快捷键)
2、Editor—>Live Templates—>点击+号。添加一个templates group来放置自己快捷键,效果图如下:
3、选中创建的MyGroup—>再次点击+号,添加一个Live template
4.还是在fifile->setting->Editor->LiveTemplates这个路径下点击一下刚刚你添加的那个名字MyGroup,然后点击右边 上面那个+号,选择LiveTemplate,填写下面设置自定义的快捷键模板:
Abbreviation:快捷键,
Description:描述该快捷键
Template text:自定义的快捷键模板
**
* @Description: $description$
* @Param: $params$
* @Return: $return$
* @Author: xj0927
* @Date Created in $data$ $time$
*/
5.设置注释的关联变量:先设置好Template text内容后—>Edit variables,变量如效果图设置就好。效果图:
注意:注意:注意:设置完应用一下Apply
应用的时候直接在方法前边写:/+快捷键名+Enter键。即可,比如我设置的快捷键方法名是a,效果图便是:
设置完成~~~~