IDEA类和方法的文档注释

最新推荐文章于 2024-08-10 23:27:38 发布

原创最新推荐文章于 2024-08-10 23:27:38 发布 · 1.6k 阅读

5 ·

CC 4.0 BY-SA版权

文章标签：

#intellij idea #java

本文档详细介绍了如何在IntelliJ IDEA中为类和方法添加文档注释。包括自动添加注释的设置，如在类注释中设置className、description、author、date和version，以及创建自定义的Live Templates来快速生成方法和构造器的注释，通过Expression定义变量获取相关信息，并指定模板的应用范围。

1. 类和方法的文档注释

1.1类注释

1）示例

2）创建类时自动添加注释

点击左上角file-sttings-Editor-File and Code Templates-files-Class

在Class里输入如下内容

className: ${NAME} ：类名称，${NAME}自动获取当前类名称

description: ${description} ：描述当前类

author: smile ：作者信息

date: ${DATE} ${TIME} ：日期与时间，${DATE}自动获取当前日期，${TIME}自动获取当前时间

version: 1.0 ：版本

：换行符（当鼠标悬停在类名上时将各项信息分行显示）

/**
 * className: ${NAME}<br>
 * description: ${description}<br>
 * author: smile<br>
 * date: ${DATE} ${TIME}<br>
 * version: 1.0<br>
 */

3）自行添加类注释

点击左上角file-sttings-Editor-Live Templates-"+"-Template Group

输入新建Group的名称后点击OK

选择刚刚创建的Group后点击+再点击Live Template创建实时模板

设置模板信息

Abbreviation：触发模板的缩写

Description：模板描述信息

Template text：注释模板的

Expand with：触发模板缩写的按键

$classname$，$date$ $time$：变量

：换行符（当鼠标悬停在类名上时将各项信息分行显示）

在Template text里输入如下内容，输入完后在Expand with选项里选择一个触发的按键

/**
 * className: $classname$<br>
 * description: <br>
 * author: smile<br>
 * date: $date$ $time$<br>
 * version: 1.0<br>
 */

配置模板变量

点击Edit variable

在Expression输入对应的表达式

Name：变量名称

Expression：表达式（获取变量想要返回的结果）

Default value：默认值（当表达式无法获取但值时将返回改项填写的内容）

Skip if defined：跳出编辑模式（勾选后当模板在代码里生成时光标不会自动跳到改变量上）

className()：获取当前类名称

date()：获取当前日期

time()：获取当前时间

配置完成后点击ok

设置模板应用的区域

点击Change，勾选JAVA

勾选完成后点击Apply应用再点击OK

1.2方法、构造器注释

1）示例

2）自行添加方法、构造器注释

添加方法与自行添加类注释方法基本一致

点击左上角file-sttings-Editor-Live Templates-smile-"+"-Live Template

如没有创建smile组，则点击Template Group创建

设置模板信息

Abbreviation：触发模板的缩写

Description：模板描述信息

Template text：注释模板的

Expand with：触发模板缩写的按键

$params$，$returns$，$date$ $time$：变量

：换行符（当鼠标悬停在类名上时将各项信息分行显示）

在Template text里输入如下内容，输入完后在Expand with选项里选择一个触发的按键

*
 * description: 
 * $params$
 * @return: $returns$<br>
 * date: $date$ $time$<br>
 * author: smile<br>
 * version: 1.0
 */

配置模板变量

点击Edit variable

在Expression输入对应的表达式

Name：变量名称

Expression：表达式（获取变量想要返回的结果）

Default value：默认值（当表达式无法获取但值时将返回改项填写的内容）

Skip if defined：跳出编辑模式（勾选后当模板在代码里生成时光标不会自动跳到改变量上）

date()：获取当前日期

time()：获取当前时间

在params变量里填入如下表达式

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

在returns变量里填入如下表达式

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())

配置完成后点击ok