IntelliJ IDEA注释模板详解

矫情吗；* 2023-03-02 04:54 32阅读 0赞

一个从Eclipse转换Idea的码农，在使用IntelliJ IDEA的过程中，需要设置一些注释，其实网上有很多类似于idea模板注释的文章，但笔者在使用过程中，或多或少的会遇到一些莫名其妙的情况，但很多现有的文章都没有给出类似的解决方法，所以笔者在使用过程中会总结一些自己的心得，希望能给读者朋友一些帮助，如果有不妥之处，希望大家批评指正，共同学习！

首先给大家展示一下笔者使用模板的效果图示，然后根据图示粗略的讲解一下配置过程

![2020072717412536.png][]

一、首先我们来设置IDEA中类的模板：（IDEA中在创建类时会自动给添加注释）

File-->settings-->Editor-->File and Code Templates-->Files（Idea默认的快捷键为ctrl+alt+s）

![20200727174611132.png][]

Class文件（当然你要设置接口的还也可以选择Interface文件）注释设置

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} !="")package ${PACKAGE_NAME};#end
     
    /**
    * All rights Reserved, Designed By www.super-master.cn
    * @ProjectName: ${PROJECT_NAME}
    * @Package: ${PACKAGE_NAME}
    * @ClassName: ${NAME}
    * @Description: []
    * <p> </p>
    * @Author: [Lance Ting]
    * @Date: ${DATE} ${TIME}
    * @Version: V1.0
    * @Copyright: ${YEAR} www.super-master.cn Inc. All rights reserved. 
    * TODO: 注意,本文件Lance Ting所作,如果转载或使用请标明具体出处!
    **/
    public class/interface/enum ${NAME} {
     
    }

至于@属性，这个根据自己需要来，可以不用完全按照笔者的来！

效果图示为

![20200727174817508.png][]

需要注意的是：如果你添加了\#if ($\{PACKAGE\_NAME\} && $\{PACKAGE\_NAME\} !="")package $\{PACKAGE\_NAME\};\#end，那么就添加 \#parse("File Header.java")必须放在后面，

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} !="")package ${PACKAGE_NAME};#end
    #parse("File Header.java")

否则在创建类时，会自动导入两个包名（笔者之前一直不知道什么问题，所以大家需要特别注意只这一点儿），当然也可以不用添加 \#parse("File Header.java")，一般笔者会把Class、Interface、Enum都会加上注释模板（这个根据自己需要来）。

二、设置方法注释模板

1、设置Live Templates，File-->Settings-->Editor-->Live Templates

1.1添加Template Group![20200727180621308.png][]

1.2 选中已添加的Template Group（common templates）,点击+，添加 【1.Live Template 】

![20200727181436513.png][]

Template text

*
     * @Description: [$description$]
     * <p></P>
     * @Title: $title$
     * @Author: Lance Ting
     * @Date: $date$
     * @Param: $params$
     * @Return: $return$
     * @Throws: $throws$
     */

1.3、修改模板属性显示方式 Edit variables,这样可以美化方法注释显示，params默认显示为数组形式

![20200727181705918.png][]

需要特别注意的是

params

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+= params[i] + ' '}else{result+='\\n' + ' * @Param: ' + params[i] + ' '}}; return result;}", methodParameters());

result

groovyScript("def returnType = \"${_1}\"; def result =  returnType; return result;", methodReturnType());

保存设置，显示效果图示为

![2020072718241450.png][]

特别说明

1、idea默认的生成注释方式为  /\*+模板名+快捷键  当注释模板是 /\*\*\* \+ enter键

2、Template text选项框值第一行 \*需要放在第一行，否则注释显示为 /\* \*而置灰

![20200727183023754.png][]

显示效果

![20200727183157353.png][]

所以，一定要把第一行和第二行错一列！！

OK！到这里基本的注释配置已经完成了！

\------------------------------------------------------------------------  
作者：编码世界  
来源：CSDN  
原文：https://blog.csdn.net/dgxin\_605/article/details/107616635  
版权声明：本文为博主原创文章，转载请附上博文链接！

\------------------------------------------------------------------------

[2020072717412536.png]: /images/20230208/645818c7fdb6437299392c80de1db7b4.png
[20200727174611132.png]: /images/20230208/41d6321637e9444795c59d52d30a7805.png
[20200727174817508.png]: https://img-blog.csdnimg.cn/20200727174817508.png
[20200727180621308.png]: https://img-blog.csdnimg.cn/20200727180621308.png
[20200727181436513.png]: https://img-blog.csdnimg.cn/20200727181436513.png
[20200727181705918.png]: https://img-blog.csdnimg.cn/20200727181705918.png
[2020072718241450.png]: https://img-blog.csdnimg.cn/2020072718241450.png
[20200727183023754.png]: https://img-blog.csdnimg.cn/20200727183023754.png
[20200727183157353.png]: https://img-blog.csdnimg.cn/20200727183157353.png