IntelliJ IDEA为类和方法自动添加注释

川长思鸟来 2023-03-01 05:50 177阅读 0赞

**阅读目录：**

*  [1、为类添加自动注释模版][1]
 *  [2、为方法添加自动注释模版][2]

**阅读正文：**

1、为类添加自动注释模版

File-->Settings-->Editor-->File and Code Templates

![format_png][]

/**
     * @author     ：mmzs
     * @date       ：Created in ${DATE} ${TIME}
     * @description：${description}
     * @modified By：
     * @version:     $version$
     */

此时，当你创建新的类时，就会自动生成注释了。

**注意：**一定要启用该模板才有效

![format_png 1][]

如果还不行，就添加如下设置：

![format_png 2][]

## 2、为方法添加自动注释模版 ##

File-->Settings-->Editor-->Live Templates

![format_png 3][]

点击"+"号后，选择"Templates Group…"

![format_png 4][]

![format_png 5][]

![format_png 6][]

**注意：**此处一定要为刚刚的模板指定使用范围：

![format_png 7][]

**例如：**我指定的是java

![format_png 8][]

注释模板填写内容参考如下：

/**
     * create by: mmzs
     * description: TODO
     * create time: $date$ $time$
     * 
     $params$
     * @return $return$
     */

![format_png 9][]

params的Exception内容如下：

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'+'\\b' : '')}; return result", methodParameters())

点击Ok。

此时，在方法体内部输入add+Tab就可以生成注释了。

[1]: https://www.cnblogs.com/mmzs/p/8858634.html#_label0
[2]: https://www.cnblogs.com/mmzs/p/8858634.html#_label1
[format_png]: /images/20230209/c091aac8c360408da03c4e2b435f8223.png
[format_png 1]: /images/20230209/623dee1711e84768888509032fa331bb.png
[format_png 2]: /images/20230209/9f755098f9164e35bae80d1e6d3f6b54.png
[format_png 3]: /images/20230209/7ff4e436a58549978827c04ed39c4a6b.png
[format_png 4]: /images/20230209/8c99b0f99ef24313a324c05179133840.png
[format_png 5]: /images/20230209/44b2e5c0469a4aadbaf4eb8614fa7618.png
[format_png 6]: /images/20230209/628e02471c7e438c8f7d28a118c9a67a.png
[format_png 7]: /images/20230209/03125bd7571f4b8492636ac0457f4153.png
[format_png 8]: /images/20230209/6b9b56d341314bb39fe7fcbc8381b885.png
[format_png 9]: /images/20230209/dc74b9806845485889ca655e606eef79.png