Java如何配置IDEA自定义注释
作者:还债.
在IDEA中设置自动创建类和方法的注释可以提高编码效率,确保代码的一致性和可读性,首先,对于创建类的注释,可以通过修改File→Settings→File and Code Templates→Class的模板来实现,其次,对于方法注释
一、创建类时自动创建注释
1.打开配置页面
路径:File → Settings → File and Code Templates → Class
2.复制下列格式到IDEA中
/** * @program: ${PROJECT_NAME} * @description: ${description} * @author: zk * @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE} **/
3.新建Java类查看效果图
二、创建方法时自动创建注释
1.打开配置页面
路径:File → Settings → Live Templates
2.创建一个新的模板组
3.为模板组起个名字
4.在新建的模板组中新建模板
abbreviation
:配置触发方式Description
:模板描述(选填)Expand with
:生成模板方式,与abbreviation组合使用,以下图配置方式举例,配置后生成注释的触发方式为:/**+Tab键
4.复制以下内容填写到Template text中
** * $params$ * @Author: zk * @Date: $date$ $time$ */
5.填写后点击填写后
点击Edit Template Variables设置字段的展示方式
复制以下内容设置param的Expression值
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+='* @param ' + params[i] + ((i < params.size() - 1) ? '\\r\\n' : '')}; return result", methodParameters())
按下图配置date与time的Expression值
6.新建Java类查看效果图
总结
以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。