idea 注释模板详细设置
idea是我们常用的工具,注释在我们开发过程中也是不可或缺的一项内容。今天做了模板设置记录下,希望能够帮助到需要的人。
最终效果:类注释,方法注释
- 对类模板进行设置(最终效果是new class时候自动填充注释)
- File-->settings-->Editor-->File and Code Templates-->Files
- 进人选项卡,files-->class
- 在原来的类名和包名中间添加注释模板信息
- ${NAME} 是直接获取类型,注意一定是大写否则无法获取到类名新建的时候需要手动输入
- ${PACKAGE_NAME}是包路径,一样也是大写
- ${ATE} ${TIME} 显示时间
- 可以根据个人的需要对信息内容进行调整
/**
* @author lxy
* @Title: ${NAME}
* @Package: ${PACKAGE_NAME}
* @Description: TODO
* @version V1.0
* @date ${DATE} ${TIME}
**/
2.对方法级别的注释模板设置
1.IDEA无法自己直接创建方法注释,这就是要我们手动为方法添加注释,根据操作习惯我们这里设置输入:*+enter 的时候进行注解的填充。注意:该模板设置好以后以为要获取方法的入参和返回值,但是idea只能在方法内获取到这些参数,所以方法模板设置完成后一定要把光标定在方法内然后*+enter生成注释再剪切到方法上面,否则生成的注解中无法获取入参和返回值;
2.File-->Settings-->Editor-->Live Templates
1.点击加号新建group ---> 新建模板 -->输入abbreviation就是生成注释enter前的字符(此处用*)--->输入描述 --->右下角点击expand(执行填充注释的按键)---> 点击正下方define --->选择java --->填写模板内容 --->对内容的参数进行绑定
/**
* @Param $param$
* @return $return$
* @Description //TODO
* @Date $date$ $time$
**/