IntelliJ IDEA 2022 类和方法注释模板设置

叁歲伎倆 2024-04-06 09:54 93阅读 0赞

### 一、概述 ###

IDEA自带的注释模板一般都很简单，然而我们在写代码的时候喜欢把类注释和文档注释写在代码里，既方便自己看所有的参数，也便于以后维护代码的时候看到编码作者。下面是我的代码注释，我们就按照这种格式来设置：  
![在这里插入图片描述][10ae9fcea28742c084082743170e1bdb.png]

### 二、类注释模板 ###

File–>settings–>Editor–>File and Code Templates–>Files  
文件->设置->编辑器->文件和代码模板->文件  
插入备注信息到public上方

/**
    * 类名称：${NAME}
    * 描述: 
    * 创建人：XXX
    * 创建时间：${DATE} ${TIME}
    */

![在这里插入图片描述][80d0a4b946fa43ab919c972e62b7b319.png]

### 三、方法注释模板 ###

**1、创建模板**  
IDEA还没有智能到自动为我们创建方法注释，这就是要我们手动为方法添加注释，我们的习惯是 /\*+Enter，这里我们也按照这种习惯来设置IDEA的方法注释

File–>Settings–>Editor–>Live Templates  
文件->设置->编辑器->实时模板  
新建组  
![在这里插入图片描述][e179737e2e85449985c66749007e046a.png]  
2、设置模板内容-IDEA格式模板  
![在这里插入图片描述][bed8b2abbb2d420da30d0b20786b7d87.png]

**
     * 方法名称：
     * 方法描述：
     * 创建人：XXX
     *
     * $params$
     * @return $return$
     */

3、编辑右侧变量

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

![在这里插入图片描述][c185ae2ddad84fe48ce3cc04616fd6d2.png]  
4、设置模板应用场景  
点击模板页面最下方的警告，来设置将模板应用于那些场景，一般选择EveryWhere–>Java即可

（如果曾经修改过，则显示为change而不是define）  
![在这里插入图片描述][b04069535abd44d0b3f5c51abe0b1ed2.png]  
![在这里插入图片描述][f8f94ee7bba149a2b51aafcd40702da9.png]  
其实我后来放弃这么搞了，明明插件就可以搞定的问题，弄这么复杂，直接用easy javadoc插件就可以了，比这个强大，还能自动翻译

[10ae9fcea28742c084082743170e1bdb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/ee0d6a16b19c46d3b54532eeb013567f.png
[80d0a4b946fa43ab919c972e62b7b319.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/4df7a4adb3af4a27b8e420588ed01e08.png
[e179737e2e85449985c66749007e046a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/e233daef72b64ff484917a8d0c4d3064.png
[bed8b2abbb2d420da30d0b20786b7d87.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/e63108139e964f70ae9921b1004dbfd2.png
[c185ae2ddad84fe48ce3cc04616fd6d2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/6ce580efafc746d798642707828cfdf3.png
[b04069535abd44d0b3f5c51abe0b1ed2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/97a6e3fc98c2436a9422c1e870f1d24c.png
[f8f94ee7bba149a2b51aafcd40702da9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/dc5ecbbbe2f641dfa41e1b3378af0b62.png