java idea 配置注释模板

不是光头强

已于 2022-07-29 10:44:27 修改

阅读量490

点赞数

CC 4.0 BY-SA版权

分类专栏：工具文章标签： intellij-idea java ide

于 2022-07-28 18:34:21 首次发布

本文链接：https://blog.youkuaiyun.com/cxdn_czj/article/details/126039598

工具专栏收录该内容

2 篇文章

订阅专栏

本文详细介绍了如何在Java IDEA中配置类注释和方法/属性注释模板，包括设置文件模板、创建Live Templates以及使用Groovy脚本来自动生成参数和返回类型注释。通过这些步骤，可以提升代码规范性和注释的完整性，便于团队协作和代码维护。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

java idea 配置注释模板

最近项目组在加强代码规范管理。代码优雅从代码注释开始。奥力给！！！

类注释的

File >> Settings >> Editor >> File and code Templates >> Files >> class
在这里插入图片描述
上图中的模板内容如下：

 /**
 * @description:
 * @PackageName: ${PACKAGE_NAME}
 * @ClassName: ${NAME}
 * @copyright: Copyright (c) 2022<br>
 * @company: xxx
 * @author: xxx
 * @date: ${DATE} ${TIME}
 * @version: 1.0
 */
  public class ${NAME} {
 
 }

方法或者属性模板的配置

File >> Settings >> Editor >> Live Templates
在这里插入图片描述
方法或者属性的注释模板；
1）先创建分组
2）然后在分组下面创建对应的注释模板

上图两处是决定输入什么弹出。

template text 如下图

*
 * @description
 $params$
 * @return $return$ 
 * @author czj       
 * @date $DATE$ $TIME$
 */

上图中的 params

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(i == 0 && params[i] == ''){return '';};result+='* @param ' + params[i] + ((i < params.size() - 1) ? '\\n ' : ' ')}; return result", methodParameters())

上图中的 return

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split('<').toList(); for(i = 0; i < params.size(); i++) {if(i!=0){result+='<';};  def p1=params[i].split(',').toList();  for(i2 = 0; i2 < p1.size(); i2++) { def p2=p1[i2].split('\\\\.').toList();  result+=p2[p2.size()-1]; if(i2!=p1.size()-1){result+=','}  } ;  };  return result", methodReturnType())

注意上图  params 和   return 位置

引用博客

https://blog.youkuaiyun.com/yy12345_6_/article/details/123830038
https://blog.youkuaiyun.com/zeal9s/article/details/83514565
https://blog.youkuaiyun.com/xiaoliulang0324/article/details/79030752