IDEA 设置文档注释

爱被打了一巴掌 2022-12-29 15:27 161阅读 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、设置方法文档注释模板 ###

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

### 3.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/20221120/09b4da1e91124448848fb0788ef79646.png
[image-20200712164228773]: /images/20221120/00468728f52242aea454017c216f458f.png
[image-20201223150613354]: /images/20221120/8b427af215524ad481bc1a0bfd8f0d9d.png
[image-20201223151111901]: /images/20221120/922555b2e71440b3bfdac27bf88c0368.png
[image-20201223151806326]: /images/20221120/7692ce5a1991436d9c8adc67e9f0d7ef.png
[image-20201223151840753]: /images/20221120/b7f727da622548eebb912a99ca5b715c.png