IDEA 设置文档注释

痛定思痛。 2023-01-09 15:56 169阅读 0赞

# IDEA 设置文档注释 #

## 1、参考资料 ##

1.  [IDEA类和方法注释模板设置（非常详细）][IDEA]
2.  [idea注释模版配置（吐血推荐！！！）][idea]

## 2、类文档注释 ##

### 2.1、设置类文档注释模板 ###

在【File and Code Templates】页面设置类（Class）的文档注释

![image-20200712164023373][]

/**
     *@ClassName ${NAME}
     *@Description  TODO
     *@Author ${USER}
     *@Date ${DATE} ${TIME}
     *@Version 1.0
     */

### 2.2、使用类文档注释 ###

注意：只有**新建类**的时候，才能创建类的文档注释哦

![image-20200712164228773][]

## 3、设置接口文档注释 ##

### 3.1、设置接口文档注释模板 ###

同样的方法，在【File and Code Templates】页面设置接口（Interface）的文档注释

![image-20210122112115886][]

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
    #parse("File Header.java")
    /**
     *@InterfaceName ${NAME}
     *@Description  TODO
     *@Author Oneby
     *@Date ${DATE} ${TIME}
     *@Version 1.0
     */
    public interface ${NAME} {
    }

### 3.2、使用接口文档注释 ###

注意：只有**新建接口**的时候，才能创建接口的文档注释哦

![image-20210122112100734][]

## 4、方法文档注释 ##

### 4.1、设置方法文档注释模板 ###

1.  在【Live Templates】中新建一个模板
    
    ![image-20201223150613354][]
2.  默认会新建一个名为 user 的分组（我也懒得改名字了）
    
    1.  `Abbreviation：*` 表示在方法上输入 `*`，再敲击 Enter 就能出现方法文档注释
    2.  Description：为方法添加文档注释
    3.  Template Text：模板内容
    4.  Applicable in Java：仅在 Java 文件中生效
    
    ![image-20210107171754521][]
3.  为模板上的变量添加默认值
    
    ![image-20201223151806326][]
4.  方法文档注释的模板
    
        ** 
         * @description: $description$
         $params$
         * @return: $returns$
         * @author Oneby
         * @date: $date$ $time$
         */
5.  `params` 的 `default value`：
    
        groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+='* @param: ' + params[i] + ((i < params.size() - 1) ? '\\n ' : '')};return result", methodParameters())methodParameters())

### 4.2、使用方法文档注释 ###

Nice~~~

![image-20201223151840753][]

[IDEA]: https://blog.csdn.net/xiaoliulang0324/article/details/79030752
[idea]: https://blog.csdn.net/u010608551/article/details/107557003
[image-20200712164023373]: /images/20221119/1da9212516024648bc689383a265d9c6.png
[image-20200712164228773]: /images/20221119/b7c7ef301ab44deb9caee785591f10e7.png
[image-20210122112115886]: /images/20221119/83f5fac2e26b41f28292f02cb7bb7c9c.png
[image-20210122112100734]: /images/20221119/ac16de1b55014f6b80ae246e44af21e6.png
[image-20201223150613354]: /images/20221119/330cf480fe4b4df7a2f7a94141cad8aa.png
[image-20210107171754521]: /images/20221119/6872a2848a80440da5b0b0bb4edd6099.png
[image-20201223151806326]: https://img-blog.csdnimg.cn/img_convert/a0cd35578fe802fe3248136ee6c75b41.png
[image-20201223151840753]: https://img-blog.csdnimg.cn/img_convert/63d016f6f699ed322d7e77989f925492.png