idea注释模版「建议收藏」

编程小6 idea (106) 2023-03-31 12:12

Hi，大家好，我是编程小6，很荣幸遇见你，我把这些年在开发过程中遇到的问题或想法写出来，今天说一说idea注释模版「建议收藏」,希望能够帮助你!!!。

此处只要是为了记录一下在idea开发过程中的一些Java注释，以前总是去找，没有收藏，而且也不是自己想用的，记录一下，省的找~
这个主要是自己用的注释模板，可能写的简单一点，望见谅！

找到 idea 的设置
找到 File and Code Templates
找到 File 里的 class/Interface/Enum

/** * ${TODO} * * @author ${USER} * @date ${YEAR}/${MONTH}/${DAY} ${HOUR}:${MINUTE} */

找到 Live Templates
找到右上角的+号
点击选择2. Template Group… 添加一个分组，名字可以自己定，我用自己名字定义的zjx
找到建好的group，点击右上角+号，选择1. Live Template

我主要是配置了两个模板

字段添加注释

就比如在 entity 里的字段

    /** * 备注 */
    private String remark;

模板看截图

方法添加注释

就比如方法上的注释

    /** * 认证身份 * * @param customerIdCard customerIdCard * @return com.hj.project.entity.CustomerIdCard * @author zhujx * @date 2020/6/12 14:14 */
    CustomerIdCard authIdCard(CustomerIdCard customerIdCard);

模板看截图

快捷键配置 * 是因为可以直接/** 回车就可以出来了
模板见下

*
 *  $todo$
 * 
$params$ 
 * @return $return$
 * @author $user$
 * @date $date$ $time$
 */

同样还需要配置一些其他的东西，点击 Edit variables

其他的就不说了，主要是 params

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

好了，这样就完事了。

如果你喜欢这篇文章，对你有帮助，就请点个赞，加个关注吧！！！