IDEA JAVA文档注释和方法注释模板

IDEA JAVA文档注释和方法注释模板

文档注释

在这里插入图片描述

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
 * @ClassName ${NAME}
 * @Description ${Description}
 * @Author ${USER}
 * @Date ${DATE} ${TIME}
 * @Version V1.0
 */
public class ${NAME} {
}
  • $ {NAME}和class后面的${NAME}相同,得到类名
  • ${Description}在创建类是会要你添加描述
    在这里插入图片描述

  • ${USER}是主机名,可以在idea安装包的bin下的idea.exe.vmoptions进行更改(64位操作系统为idea64.exe.vmoptions),在里面添加-Duser.name=xxx即可,这样idea识别的主机名就是自己定义的了
    在这里插入图片描述

  • ${DATE} ${TIME}是时间和日期

  • @Version V1.0 这是项目的版本,一般为1.0

方法注释

在这里插入图片描述

这里是定义模板的地方

  1. 自己创建模板组

    在这里插入图片描述

  2. 自定义名称
    在这里插入图片描述在这里插入图片描述

  3. 添加模板

    在这里插入图片描述

  4. 编写模板

    在这里插入图片描述
    在这里插入图片描述

我这里设置的快捷键是**,然后输入/和这个之后按tab就可以生成注释了

**
 * @Author LiangHui
 * @Description $description$
 * @Date $time$ $date$ 
 $params$
 * @return $return$
 */

然后是变量设置

在这里插入图片描述

params有所不同,要自己手动输入

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

最后还要设置使用范围

在这里插入图片描述

已经设置的点击Change可以更改,没有设置的也在同样的位置可以设置

在这里插入图片描述

输入/** + tab 生成注释,虽然param没有对齐,但是当输入方法描述或者按tab、enter就会自动对齐了

在这里插入图片描述
在这里插入图片描述

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值