通过配置IDEA实现注释风格统一

豆皮哥

已于 2023-03-01 10:59:59 修改

阅读量814

点赞数

分类专栏： Java 文章标签： intellij-idea 编辑器 java

于 2023-02-27 12:51:42 首次发布

本文链接：https://blog.csdn.net/scofild950303/article/details/129239693

版权

Java 专栏收录该内容

14 篇文章 2 订阅

订阅专栏

本文介绍了如何在IntelliJIDEA中配置代码注释模板，包括添加FileHeader模板，配置FileHeader和LiveTemplates，以及为类、方法和常量设置快捷键生成注释的方法。用户可以自定义模板并使用c+Tab、m+Tab、s+Tab等快捷键快速生成注释。

摘要由CSDN通过智能技术生成

本篇主要讲如何进行注释模板的配置。下面将会说明如何通过快捷键 + Tab 的方式直接呼出格式统一的类、方法、变量的注释模板。

配置代码注释模板

1) 添加File Header模板

File->settings->Editor->File and Code Templates->includes；添加一个File Header模板

/**
 * TODO 写明类的作用
 * @author ${USER}
 * @project ${PROJECT_NAME}
 * @title $title
 * @package ${PACKAGE_NAME}
 * @since ${DATE} ${TIME}
 */

2)配置FileHeader注释。

然后选择 Files -> Class -> 添加类文件头描述; 当然如果你想对Interface进行处理同样操作即可

3)自定义 Live Templates

打开IDEA Settings -> 搜索live Templates -> 点击 + 号创建一个自定义的 {这里最好填公司缩写,例如 whdsj} 注释模板。

a) live templates配置

创建类、方法、常量的 live templates 模板

配置快捷键 c+Tab，代表快速生成class注释模板

/**
* @description *
* @author chentl
* @version 1.0
* @class $class_name$
* @package $package$
* @since $date$ $time$
*/

配置快捷键 m+Tab，快速生成method注释模板

/**
 * TODO
 * @author chentl 
 * @version v1.0.0	
 * @since $time$ $date$
$param$
 * @return $return$
 **/

配置快捷键 s+Tab，快速生成method注释模板

/** 
* @description *
* @author chentl 
* @since $date$ $time$ 
**/

b) 模板中的表达式配置

一般参考上图使用默认配置方式，另外$param$和$return$需要额外增加gs表达式。具体代码已经贴出来了，如下：

如果希望 @param 自动换行并且，出现鼠标悬停提示，需要遵循javadoc注释格式。那么在配置表达式时，method 和return需要特殊配置。将如下加粗内容复制到expression中即可。

// $param$ 表达式如下，复制到Expression中即可。
groovyScript("  if(\"${_1}\".length() == 2)   { return ''; }   else   {  def result='*';  def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();  for(i = 0; i < params.size(); i++)   {   if(i==0)  result=' * @param ' + params[i] + ' ' + params[i] + '\\r\\n';  else   result+=' * @param ' + params[i] + ' ' + params[i] + ((i < params.size() - 1) ? '\\n' : '\\n') }; return result }  ", methodParameters()) 

// $return$ 表达式如下，复制到Expression中即可。
groovyScript("def result=\"${_1}\"; if(result == \"void\"){return \"\";}else{return \"{@link \"+result+\"}\";}", methodReturnType())