IDEA2020.2版本設定類和方法的自定義註釋模板

勝金發表於2021-06-23

  IDEA是目前普遍使用的Java開發編輯器,新增自定義的註釋模板,一方面便捷好用,另外一方面可以規範開發。IDEA中設定模板分兩種:1、建立Java類的註釋,2、方法的註釋。

  一、Java類的註釋模板

  1、開啟File→Settings,選擇Editor→File and Code Templates→Files→Class。可以看到建立類的時候引入了File Header.java。

 

   2、接下來我們可以看一下Files旁邊的Includes標籤,裡面的File Header就是我們要建立的File Header.java,右側的空白出新增我們需要的模板就可以了,下面的描述是模板引用的變數使用方法,比如時間、包名、專案名等。

 

 

   3、比如我們設定如下的內容,點選OK,再建立類的時候就會自動生成註釋。

 

   效果如下:

 

   二、方法的註釋模板

   1、開啟File→Settings,選擇Editor→Live Templates。

 

   2、點選右側的“+”選擇Template Group,建立分組,分組名自定義,例如:MyTemplates,點選OK即可。

 

 

 

   3、找到剛建立的MyTemplates分組並選中,點選右側的“+”,選擇Live Template,寫入要配置的內容:

 

   配置的內容:

  1)Abbreviation:模板的縮寫,可以是【/*】【/**】【*】等,看個人習慣了,後面會介紹用法。

  2)Description:模板的描述,方便自己以後查詢。

  3)Template text:模板的內容,引數名用 $引數名$ 格式。

  4)Options→Expand with:模板的擴充套件快捷鍵,可以按照個人習慣選擇,我用的是Enter鍵,後面會介紹用法。

  4、配置模板格式

/**
 * 功能描述:
 * TODO
 *
$params$
 * @return $return$
 * @author JohanChan
 * @date $DATE$ $TIME$
 */

  如上,配置自己想要的格式,需要注意的是引數要頂頭寫,直接用$params$,前面不要有空格和【*】。

  5、設定變數引數

  點選Edit variables,列表中顯示的就是剛剛配置的模板的引數 $引數名$,在Expression中下拉選擇方法為其賦值;對於 $params$ 引數需要注意,IDEA給我們預設的是methodParameters()方法,這個方法是把形參顯示在一行,我們需要的是一行一個引數這樣顯示,可以通過自定義指令碼實現,把下面的指令碼複製到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())

 

 

   6、測試效果

  點選OK就可以完成配置,以上就配置完成。使用的時候,先建立一個方法,然後在方法外上一行中輸入 /* 點選Enter鍵,就自動生成了對應的註釋,注意:在方法外使用註釋模板生成的註釋不能生成param和return,目前我不知道什麼原因,有知道原因和解決辦法的小夥伴歡迎留言指教。這個問題的臨時解決辦法是:在方法內輸入 /* 點選Enter鍵,生成註釋後copy到方法外面使用。最終效果如下:

 

相關文章