小技巧分享 idea软件中设置统一JavaDoc模板的详细方法 -我爱编程

当前位置：: 首页; 文章; 后端
详情

小技巧分享 idea软件中设置统一JavaDoc模板的详细方法

后端
猿友
0

相信很多人在看许多 Java 教学视频的时候，都会疑惑他们在创建一个新的 class 文件，总会出现一些注释，比如作者 author 、日期 date 等等。今天，我将和大家分享一下，怎么在 idea 这款软件上自定义一个统一的 JavaDoc 模板。

idea设置统一JavaDoc模板

设置普通注释

按照如下导航找到位置：

Setting > Editor > File and Code Templates > Includes > File Header

复制如下，即可实现简单的JavaDoc注释

/**
 * @author : ChenLiWu
 * @date : ${DATE} ${TIME}
 */

2021040308371946

自定义模板

方法注释

按照如下导航找到位置：

Setting > Editor > Live Templates

看到右边的 + 按钮，选择第二项 2. Template Group… Group 名字随便定义

增加好 Group 之后，点击选中自己添加的 Group，再点击右边的**+**选择第一项 1. Live Template

按照下图设置，

**
 * description: $description$
$params$
 * @return $return$
 * @throws $throws$
 * @author ChenLiwu
 * @date $date$ $time$
 */

2021040308371947

其中params对应的是用脚本写的：

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

2021040308371948

类名注释

同理：

**
 * description: $description$
 * @author ChenLiwu
 * @version 1.0
 * @date $date$ $time$
 */

2021040308371949

这样一来“/” + 你的快捷触发键 + 快捷生成按钮即可一键生成你要的javadoc模板注释

到此这篇关于在 idea 软件中如何设置 JavaDoc 统一模板的小技巧就介绍到这了,想要了解更多相关 idea 软件其他的操作内容请搜索W3Cschool以前的文章或继续浏览下面的相关文章，希望大家以后多多支持！

免责申明：本站发布的内容（图片、视频和文字）以转载和分享为主，文章观点不代表本站立场，如涉及侵权请联系站长邮箱：xbc-online@qq.com进行反馈，一经查实，将立刻删除涉嫌侵权内容。