IntelliJ IDEA如何设置注释模板

清疚 2021-06-24 16:10 562阅读 0赞

## 类的注释模板 ##

1.选择菜单File->Settings->Editor->File And Code Templates->Includes->FileHeader，在右边的编辑框中设置自定义的注释模板，示例如下：

/**
    *@desc  
    *@author wunian
    *@date ${DATE}
    */

注意从第二行开始的\*不要缩进，否则创建Java Class文件的时候会报错。  
至于以$\{\}包裹的参数设置在编辑框下方的Description中有详细说明，在此不再赘述。  
2.设置完成后，勾选下方的Enable Live Templates选项并Apply。

## 方法的注释模板 ##

1.选择菜单File->Settings->Editor->LiveTemplates，点击右侧的+号，选择Template Group，创建自己的注释模板组。  
2.选中刚刚创建的注释模板组，再次点击+号，选择Live Template，在Abbreviation中设置触发注释提醒的快捷键，Description中设置描述信息，Template text中设置注释模板，示例如下：

**
     *
     *@desc 
     $params$ 
     *@return $return$ 
     *@author wunian
     *@date $date$
     */

3.被$包裹的参数可以点击右方的Edit variables进行设置其默认值或表达式。在本例中，我设置的参数的Expression如下：  
params

#此函数返回方法中的形参以竖向排列的方式显示，默认显示类似于【a,b】
    groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=(i==0?'*@param ':' *@param ') + params[i] + ((i < params.size() - 1) ? '\\n' : '')}; return result", methodParameters())

return

#此函数返回方法的返回类型
    methodReturnType()

date

#此函数返回当前日期并格式化
    date("YYYY-MM-dd")

4.在右侧的Expand with中可以设置快捷键以迅速创建注释。  
5.一切都设置完毕后，Apply即可。  
PS:如果你想实现输入/\*\*\*然后按Enter键就能够迅速创建出注释的效果，可以这样做：

Abbreviation:\*\*\*  
Expand with:Enter  
Template text:

**
     *
     *@desc 
     $params$ 
     *@return $return$ 
     *@author wunian
     *@date $date$
     */